프로비저닝 API


OpenShift Container Platform 4.16

API 프로비저닝에 대한 참조 가이드

Red Hat OpenShift Documentation Team

초록

이 문서에서는 OpenShift Container Platform 프로비저닝 API 오브젝트 및 세부 사양에 대해 설명합니다.

1장. 프로비저닝 API

1.1. BMCEventSubscription [metal3.io/v1alpha1]

설명
BMCEventSubscription은 빠른 이벤트 API의 스키마입니다.
유형
object

1.2. BareMetalHost [metal3.io/v1alpha1]

설명
BareMetalHost는 baremetalhosts API의 스키마입니다.
유형
object

1.3. DataImage [metal3.io/v1alpha1]

설명
DataImage는 dataimages API의 스키마입니다.
유형
object

1.4. FirmwareSchema [metal3.io/v1alpha1]

설명
FirmwareSchema는 펌웨어schemas API의 스키마입니다.
유형
object

1.5. HardwareData [metal3.io/v1alpha1]

설명
HardwareData는 hardwaredata API의 스키마입니다.
유형
object

1.6. HostFirmwareComponents [metal3.io/v1alpha1]

설명
HostFirmwareComponents는 hostfirmwarecomponents API의 스키마입니다.
유형
object

1.7. HostFirmwareSettings [metal3.io/v1alpha1]

설명
HostFirmwareSettings은 hostfirmwaresettings API의 스키마입니다.
유형
object

1.8. Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

설명
Metal3Remediation은 metal3remediations API의 스키마입니다.
유형
object

1.9. Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

설명
Metal3RemediationTemplate은 metal3remediationtemplates API의 스키마입니다.
유형
object

1.10. PreprovisioningImage [metal3.io/v1alpha1]

설명
PreprovisioningImage는 사전 프로비저닝 API의 스키마입니다.
유형
object

1.11. 프로비저닝 [metal3.io/v1alpha1]

설명
프로비저닝에는 프로비저닝 서비스(Ironic)에서 baremetal 호스트를 프로비저닝하는 데 사용하는 구성이 포함되어 있습니다. 프로비저닝은 프로비저닝 네트워크에 대한 정보와 PXE 부팅에 사용할 수 있는 서버의 NIC에 대한 admin 또는 사용자가 제공한 OpenShift 설치 프로그램에 의해 생성됩니다. 이 CR은 설치 프로그램에서 생성한 싱글톤이며 현재 metal3 클러스터에서 컨테이너를 가져오고 업데이트하기 위해 cluster-baremetal-operator에서만 사용합니다.
유형
object

2장. BMCEventSubscription [metal3.io/v1alpha1]

설명
BMCEventSubscription은 빠른 이벤트 API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

 

status

object

 

2.1.1. .spec

설명
유형
object
Expand
속성유형설명

context

string

이벤트에 대한 임의의 사용자 제공 컨텍스트

대상

string

이벤트를 전송할 Webhook URL

hostName

string

BareMetalHost에 대한 참조

httpHeadersRef

object

요청을 수행할 때 대상에 전달해야 하는 HTTP 헤더가 포함된 보안

2.1.2. .spec.httpHeadersRef

설명
요청을 수행할 때 대상에 전달해야 하는 HTTP 헤더가 포함된 보안
유형
object
Expand
속성유형설명

name

string

이름은 시크릿 리소스를 참조하는 네임스페이스 내에서 고유합니다.

네임스페이스

string

네임스페이스는 시크릿 이름을 고유해야 하는 공간을 정의합니다.

2.1.3. .status

설명
유형
object
Expand
속성유형설명

error

string

 

subscriptionID

string

 

2.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/bmceventsubscriptions

    • GET: 종류의 BMCEventSubscription 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

    • DELETE: BMCEventSubscription의 컬렉션 삭제
    • GET: 종류의 BMCEventSubscription 오브젝트 나열
    • POST: BMCEventSubscription 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

    • DELETE: BMCEventSubscription 삭제
    • GET: 지정된 BMCEventSubscription을 읽습니다.
    • PATCH: 지정된 BMCEventSubscription을 부분적으로 업데이트
    • PUT: 지정된 BMCEventSubscription을 교체합니다.
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

    • GET: 지정된 BMCEventSubscription의 읽기 상태
    • PATCH: 지정된 BMCEventSubscription의 부분 업데이트 상태
    • PUT: 지정된 BMCEventSubscription의 상태 교체

2.2.1. /apis/metal3.io/v1alpha1/bmceventsubscriptions

HTTP 방법
GET
설명
BMCEventSubscription 유형의 오브젝트 나열
Expand
표 2.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscriptionList schema

401 - 무단

2.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

HTTP 방법
DELETE
설명
BMCEventSubscription 컬렉션 삭제
Expand
표 2.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
BMCEventSubscription 유형의 오브젝트 나열
Expand
표 2.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscriptionList schema

401 - 무단

HTTP 방법
POST
설명
BMCEventSubscription 생성
Expand
표 2.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.5. 본문 매개변수
매개변수유형설명

body

BMCEventSubscription 스키마

 
Expand
표 2.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

201 - 생성됨

BMCEventSubscription 스키마

202 - 승인됨

BMCEventSubscription 스키마

401 - 무단

2.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

Expand
표 2.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

BMCEventSubscription 이름

HTTP 방법
DELETE
설명
BMCEventSubscription 삭제
Expand
표 2.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 2.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 BMCEventSubscription 읽기
Expand
표 2.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 BMCEventSubscription을 부분적으로 업데이트
Expand
표 2.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 BMCEventSubscription을 교체합니다.
Expand
표 2.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.14. 본문 매개변수
매개변수유형설명

body

BMCEventSubscription 스키마

 
Expand
표 2.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

201 - 생성됨

BMCEventSubscription 스키마

401 - 무단

2.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

Expand
표 2.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

BMCEventSubscription 이름

HTTP 방법
GET
설명
지정된 BMCEventSubscription의 상태 읽기
Expand
표 2.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 BMCEventSubscription의 부분적으로 업데이트 상태
Expand
표 2.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 BMCEventSubscription의 상태 교체
Expand
표 2.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.21. 본문 매개변수
매개변수유형설명

body

BMCEventSubscription 스키마

 
Expand
표 2.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BMCEventSubscription 스키마

201 - 생성됨

BMCEventSubscription 스키마

401 - 무단

3장. BareMetalHost [metal3.io/v1alpha1]

설명
BareMetalHost는 baremetalhosts API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

BareMetalHostSpec은 BareMetalHost의 원하는 상태를 정의합니다.

status

object

BareMetalHostStatus는 BareMetalHost의 관찰 상태를 정의합니다.

3.1.1. .spec

설명
BareMetalHostSpec은 BareMetalHost의 원하는 상태를 정의합니다.
유형
object
필수 항목
  • 온라인
Expand
속성유형설명

아키텍처

string

호스트의 CPU 아키텍처(예: "x86_64" 또는 "aarch64"). 설정되지 않으면 결국 검사에 의해 채워집니다.

automatedCleaningMode

string

disabled로 설정하면 프로비저닝 및 프로비저닝 해제 중에 자동화된 정리를 방지할 수 있습니다.

bmc

object

BMC에 어떻게 연결할 수 있습니까?

bootMACAddress

string

어떤 MAC 주소를 PXE 부팅합니까? 일부 유형의 경우 선택 사항이지만 vbmc에 의해 구동되는 libvirt VM에 필요합니다.

bootMode

string

부팅 중에 하드웨어를 초기화하는 방법을 선택합니다. 기본값은 UEFI입니다.

consumerRef

object

ConsumerRef를 사용하여 호스트를 사용하는 항목에 대한 정보를 저장할 수 있습니다. 비어 있지 않으면 호스트는 "사용 중"으로 간주됩니다.

customDeploy

object

사용자 정의 배포 절차.

description

string

Description is a human-entered text used to help identify the host

externallyProvisioned

boolean

ExternallyProvisioned는 다른 사용자가 호스트에서 실행 중인 이미지를 관리하고 있음을 의미하며, Operator는 전원 상태 및 하드웨어 인벤토리 검사만 관리해야 합니다. Image 필드가 입력되면 이 필드는 무시됩니다.

펌웨어

object

베어 메탈 서버에 대한 BIOS 구성

hardwareProfile

string

이 호스트의 하드웨어 프로필 이름은 무엇입니까? 하드웨어 프로필은 더 이상 사용되지 않으며 사용해서는 안 됩니다. 대신 별도의 필드 Architecture 및 RootDeviceHints를 사용합니다. 하드웨어 프로필 없이 향후 API 버전을 준비하려면 "empty"로 설정합니다.

image

object

이미지에는 프로비저닝할 이미지의 세부 정보가 있습니다.

metaData

object

메타데이터에는 구성 드라이브에 전달되는 호스트 메타데이터(예: meta_data.json)가 포함된 보안에 대한 참조가 있습니다.

networkData

object

networkData는 구성 드라이브에 전달되는 네트워크 구성(예: network_data.json의 콘텐츠)을 포함하는 보안에 대한 참조를 보유합니다.

온라인

boolean

서버가 온라인 상태여야 합니까?

preprovisioningNetworkDataName

string

PreprovisioningNetworkDataName은 사전 프로비저닝 이미지로 전달되는 네트워크 구성(예: 사전 프로비저닝 이미지에 전달되는 network_data.json의 콘텐츠)과 NetworkData를 지정하여 재정의하지 않는 경우 구성 드라이브에 있는 로컬 네임스페이스의 시크릿 이름입니다.

RAID

object

베어 메탈 서버에 대한 RAID 구성

rootDeviceHints

object

프로비저닝 중인 이미지의 장치를 선택하는 방법에 대한 지침을 제공합니다.

테인트

array

테인트는 해당 머신에 적용할 수 있는 모든 권한이 있는 테인트 목록입니다. 이 목록은 머신의 모든 수정 사항을 지속적으로 덮어씁니다.

taints[]

object

이 테인트가 연결된 노드에는 테인트를 허용하지 않는 Pod에 "효과"가 있습니다.

userData

object

userdata는 부팅하기 전에 호스트에 전달할 사용자 데이터가 포함된 Secret에 대한 참조를 보유합니다.

3.1.2. .spec.bmc

설명
BMC에 어떻게 연결할 수 있습니까?
유형
object
필수 항목
  • address
  • credentialsName
Expand
속성유형설명

address

string

address에는 네트워크에서 컨트롤러에 액세스하기 위한 URL이 있습니다.

credentialsName

string

BMC 인증 정보가 포함된 시크릿의 이름입니다(키 "사용자 이름" 및 "암호")가 필요합니다.

disableCertificateVerification

boolean

disableCertificateVerification은 HTTPS를 사용하여 BMC에 연결할 때 서버 인증서 확인을 비활성화합니다. 이는 서버 인증서가 자체 서명된 경우 필요하지만 중간자(man-in-the-middle)가 연결을 가로챌 수 있기 때문에 안전하지 않은 경우 필요합니다.

3.1.3. .spec.consumerRef

설명
ConsumerRef를 사용하여 호스트를 사용하는 항목에 대한 정보를 저장할 수 있습니다. 비어 있지 않으면 호스트는 "사용 중"으로 간주됩니다.
유형
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

네임스페이스

string

참조의 네임스페이스입니다. 자세한 내용은 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.4. .spec.customDeploy

설명
사용자 정의 배포 절차.
유형
object
필수 항목
  • method
Expand
속성유형설명

method

string

사용자 정의 배포 방법 이름. 이 이름은 사용된 배포 램디스크에 따라 다릅니다. 사용자 정의 배포 램디스크가 없는 경우 CustomDeploy를 사용해서는 안 됩니다.

3.1.5. .spec.firmware

설명
베어 메탈 서버에 대한 BIOS 구성
유형
object
Expand
속성유형설명

simultaneousMultithreadingEnabled

boolean

단일 물리적 프로세서 코어를 여러 논리 프로세서로 표시할 수 있습니다. 이는 다음 옵션을 지원합니다: true, false.

sriovEnabled

boolean

SR-IOV 지원을 사용하면 하이퍼바이저에서 PCI-express 장치의 가상 인스턴스를 생성하여 성능이 증가할 수 있습니다. 이는 다음 옵션을 지원합니다: true, false.

virtualizationEnabled

boolean

플랫폼 하드웨어의 가상화 지원. 이는 다음 옵션을 지원합니다: true, false.

3.1.6. .spec.image

설명
이미지에는 프로비저닝할 이미지의 세부 정보가 있습니다.
유형
object
필수 항목
  • url
Expand
속성유형설명

checksum

string

체크섬은 이미지의 체크섬입니다.

checksumType

string

ChecksumType은 이미지의 체크섬 알고리즘(예: md5, sha256 또는 sha512)입니다. 체크섬에서 알고리즘을 감지하는 데 특수 값 "auto"를 사용할 수 있습니다. 누락된 경우 MD5가 사용됩니다. 의심의 여지가있는 경우 "auto"를 사용하십시오.

형식

string

DiskFormat에는 이미지 형식(raw, qcow2, …​)이 포함되어 있습니다. 원시 이미지 스트리밍을 위해 raw로 설정해야 합니다. 참고 Live-iso는 url에서 참조하는 iso가 라이브 부팅되고 디스크에 배포되지 않으며 이 경우 체크섬 옵션이 필요하지 않으며 지정된 경우 무시됩니다.

url

string

URL은 배포할 이미지의 위치입니다.

3.1.7. .spec.metaData

설명
메타데이터에는 구성 드라이브에 전달되는 호스트 메타데이터(예: meta_data.json)가 포함된 보안에 대한 참조가 있습니다.
유형
object
Expand
속성유형설명

name

string

이름은 시크릿 리소스를 참조하는 네임스페이스 내에서 고유합니다.

네임스페이스

string

네임스페이스는 시크릿 이름을 고유해야 하는 공간을 정의합니다.

3.1.8. .spec.networkData

설명
networkData는 구성 드라이브에 전달되는 네트워크 구성(예: network_data.json의 콘텐츠)을 포함하는 보안에 대한 참조를 보유합니다.
유형
object
Expand
속성유형설명

name

string

이름은 시크릿 리소스를 참조하는 네임스페이스 내에서 고유합니다.

네임스페이스

string

네임스페이스는 시크릿 이름을 고유해야 하는 공간을 정의합니다.

3.1.9. .spec.raid

설명
베어 메탈 서버에 대한 RAID 구성
유형
object
Expand
속성유형설명

hardwareRAIDVolumes

``

하드웨어 RAID용 논리 디스크 목록입니다. rootDeviceHints를 사용하지 않는 경우 첫 번째 볼륨은 root 볼륨입니다. 이 필드의 값을 [] 로 설정하여 모든 하드웨어 RAID 구성을 지울 수 있습니다.

SoftwareRAIDVolumes

``

소프트웨어 RAID용 논리 디스크 목록입니다. rootDeviceHints를 사용하지 않는 경우 첫 번째 볼륨은 root 볼륨입니다. HardwareRAIDVolumes가 설정된 경우 이 항목이 유효하지 않습니다. 생성된 소프트웨어 RAID 장치의 수는 1 또는 2여야 합니다. 소프트웨어 RAID 장치가 하나뿐인 경우 RAID-1이어야 합니다. 두 개가 있는 경우 첫 번째는 RAID-1이어야 하며 두 번째 항목의 RAID 수준은 0, 1 또는 1+0일 수 있습니다. 첫 번째 RAID 장치가 배포 장치가 되므로 RAID-1을 적용하면 디스크 오류가 발생할 경우 부팅되지 않은 노드로 끝날 위험이 줄어듭니다. 소프트웨어 RAID는 항상 삭제됩니다.

3.1.10. .spec.rootDeviceHints

설명
프로비저닝 중인 이미지의 장치를 선택하는 방법에 대한 지침을 제공합니다.
유형
object
Expand
속성유형설명

deviceName

string

"/dev/vda" 또는 "/dev/vda"와 같은 Linux 장치 이름 또는 "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"과 같은 Linux 장치 이름입니다. 팁은 실제 값과 정확히 일치해야 합니다.

hctl

string

0:0:0:0과 같은 SCSI 버스 주소입니다. 팁은 실제 값과 정확히 일치해야 합니다.

minSizeGigabytes

integer

장치의 최소 크기(Gigabytes)입니다.

model

string

벤더별 장치 식별자입니다. 팁은 실제 값의 하위 문자열입니다.

rotational

boolean

장치가 회전 미디어를 사용해야 하는 경우 true이고, 그렇지 않으면 false입니다.

serialNumber

string

장치 일련 번호입니다. 팁은 실제 값과 정확히 일치해야 합니다.

vendor

string

장치의 공급 업체 또는 제조업체의 이름입니다. 팁은 실제 값의 하위 문자열입니다.

wwn

string

고유 스토리지 식별자입니다. 팁은 실제 값과 정확히 일치해야 합니다.

wwnVendorExtension

string

고유한 벤더 스토리지 식별자입니다. 팁은 실제 값과 정확히 일치해야 합니다.

wwnWithExtension

string

벤더 확장이 추가된 고유 스토리지 식별자입니다. 팁은 실제 값과 정확히 일치해야 합니다.

3.1.11. .spec.taints

설명
테인트는 해당 머신에 적용할 수 있는 모든 권한이 있는 테인트 목록입니다. 이 목록은 머신의 모든 수정 사항을 지속적으로 덮어씁니다.
유형
array

3.1.12. .spec.taints[]

설명
이 테인트가 연결된 노드에는 테인트를 허용하지 않는 Pod에 "효과"가 있습니다.
유형
object
필수 항목
  • effect
  • key
Expand
속성유형설명

effect

string

필수 항목입니다. 테인트를 허용하지 않는 pod에 테인트의 영향을 미칩니다. 유효한 영향은 NoSchedule, PreferNoSchedule 및 NoExecute입니다.

key

string

필수 항목입니다. 노드에 적용할 taint 키입니다.

timeAdded

string

TimeAdded는 테인트가 추가된 시간을 나타냅니다. NoExecute 테인트에만 작성됩니다.

value

string

taint 키에 해당하는 taint 값입니다.

3.1.13. .spec.userData

설명
userdata는 부팅하기 전에 호스트에 전달할 사용자 데이터가 포함된 Secret에 대한 참조를 보유합니다.
유형
object
Expand
속성유형설명

name

string

이름은 시크릿 리소스를 참조하는 네임스페이스 내에서 고유합니다.

네임스페이스

string

네임스페이스는 시크릿 이름을 고유해야 하는 공간을 정의합니다.

3.1.14. .status

설명
BareMetalHostStatus는 BareMetalHost의 관찰 상태를 정의합니다.
유형
object
필수 항목
  • errorCount
  • errorMessage
  • hardwareProfile
  • operationalStatus
  • poweredOn
  • provisioning
Expand
속성유형설명

errorCount

integer

ErrorCount는 마지막으로 성공한 작업 이후 호스트가 오류 발생 횟수를 기록합니다.

errorMessage

string

프로비저닝 하위 시스템에서 보고한 마지막 오류 메시지

errorType

string

ErrorType은 OperationalStatus가 OperationalStatusError일 때 발생하는 오류 유형을 나타냅니다.

goodCredentials

object

작업을 검증할 수 있는 마지막 인증 정보

하드웨어

object

호스트에 있는 하드웨어입니다.

hardwareProfile

string

하드웨어 세부 정보와 일치하는 프로필의 이름입니다.

lastUpdated

string

LastUpdated는 이 상태가 마지막으로 관찰된 시기를 식별합니다.

operationHistory

object

OperationHistory는 이 호스트에서 수행된 작업에 대한 정보를 보유합니다.

operationalStatus

string

OperationalStatus에는 호스트 상태가 있음

poweredOn

boolean

호스트의 전원이 켜졌는지의 여부를 나타내는 지표

provisioning

object

프로비저너가 추적하는 정보입니다.

triedCredentials

object

프로비저닝 백엔드로 마지막 인증 정보

3.1.15. .status.goodCredentials

설명
작업을 검증할 수 있는 마지막 인증 정보
유형
object
Expand
속성유형설명

credentials

object

SecretReference는 시크릿 참조를 나타냅니다. 모든 네임스페이스에서 시크릿을 검색하기에 충분한 정보가 있습니다.

credentialsVersion

string

 

3.1.16. .status.goodCredentials.credentials

설명
SecretReference는 시크릿 참조를 나타냅니다. 모든 네임스페이스에서 시크릿을 검색하기에 충분한 정보가 있습니다.
유형
object
Expand
속성유형설명

name

string

이름은 시크릿 리소스를 참조하는 네임스페이스 내에서 고유합니다.

네임스페이스

string

네임스페이스는 시크릿 이름을 고유해야 하는 공간을 정의합니다.

3.1.17. .status.hardware

설명
호스트에 있는 하드웨어입니다.
유형
object
Expand
속성유형설명

cpu

object

CPU는 호스트에서 하나의 프로세서를 설명합니다.

펌웨어

object

펌웨어는 호스트의 펌웨어를 설명합니다.

hostname

string

 

nics

array

 

nics[]

object

NIC는 호스트의 하나의 네트워크 인터페이스를 설명합니다.

ramMebibytes

integer

 

storage

array

 

storage[]

object

스토리지는 호스트에서 하나의 스토리지 장치(디스크, SSD 등)를 설명합니다.

systemVendor

object

HardwareSystemVendor는 전체 하드웨어 시스템에 대한 세부 정보를 저장합니다.

3.1.18. .status.hardware.cpu

설명
CPU는 호스트에서 하나의 프로세서를 설명합니다.
유형
object
Expand
속성유형설명

arch

string

 

clockMegahertz

number

ClockSpeed는 ClockSpeed의 클럭 속도입니다.

count

integer

 

플래그

배열(문자열)

 

model

string

 

3.1.19. .status.hardware.firmware

설명
펌웨어는 호스트의 펌웨어를 설명합니다.
유형
object
Expand
속성유형설명

BIOS

object

이 펌웨어의 BIOS

3.1.20. .status.hardware.firmware.bios

설명
이 펌웨어의 BIOS
유형
object
Expand
속성유형설명

date

string

이 BIOS의 릴리스/빌드 날짜

vendor

string

이 BIOS의 공급 업체 이름

version

string

BIOS 버전

3.1.21. .status.hardware.nics

설명
유형
array

3.1.22. .status.hardware.nics[]

설명
NIC는 호스트의 하나의 네트워크 인터페이스를 설명합니다.
유형
object
Expand
속성유형설명

ip

string

인터페이스의 IP 주소입니다. 해당 주소가 있는 경우 IPv4 또는 IPv6 주소가 됩니다. IPv4 및 IPv6 주소가 모두 듀얼 스택 환경에 있는 경우 각 IP가 하나씩 출력됩니다.

mac

string

장치 MAC 주소

model

string

NIC의 공급 업체 및 제품 ID (예:) "0x8086 0x1572"

name

string

네트워크 인터페이스의 이름(예: "en0")

pxe

boolean

NIC가 PXE 부팅 가능 여부

speedGbps

integer

초당 Gigabits의 장치 속도

vlanId

integer

태그되지 않은 VLAN ID

VLAN

array

사용 가능한 VLAN

vlans[]

object

VLAN은 VLAN의 이름과 ID를 나타냅니다.

3.1.23. .status.hardware.nics[].vlans

설명
사용 가능한 VLAN
유형
array

3.1.24. .status.hardware.nics[].vlans[]

설명
VLAN은 VLAN의 이름과 ID를 나타냅니다.
유형
object
Expand
속성유형설명

id

integer

VLANID는 12비트 802.1Q VLAN 식별자입니다.

name

string

 

3.1.25. .status.hardware.storage

설명
유형
array

3.1.26. .status.hardware.storage[]

설명
스토리지는 호스트에서 하나의 스토리지 장치(디스크, SSD 등)를 설명합니다.
유형
object
Expand
속성유형설명

alternateNames

배열(문자열)

디스크의 대체 Linux 장치 이름 목록(예: "/dev/sda"). 이 목록은 전체 목록이 아니며 재부팅 시 이름이 안정적이지 않을 수 있습니다.

hctl

string

장치의 SCSI 위치

model

string

하드웨어 모델

name

string

디스크의 Linux 장치 이름(예: "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"). 이 이름은 사용 가능한 경우 재부팅 시 안정적입니다.

rotational

boolean

이 디스크가 회전 스토리지를 나타내는지 여부입니다. 이 필드는 사용에 권장되지 않습니다. 대신 'Type' 필드를 사용하는 것이 좋습니다. 이 필드는 결국 더 이상 사용되지 않습니다.

serialNumber

string

장치의 일련 번호

sizeBytes

integer

disk의 크기

type

string

장치 유형, HDD, SSD, NVME 중 하나.

vendor

string

장치 공급 업체의 이름

wwn

string

장치의 WWN

wwnVendorExtension

string

장치의 WWN 벤더 확장

wwnWithExtension

string

확장 기능이 있는 WWN

3.1.27. .status.hardware.systemVendor

설명
HardwareSystemVendor는 전체 하드웨어 시스템에 대한 세부 정보를 저장합니다.
유형
object
Expand
속성유형설명

manufacturer

string

 

productName

string

 

serialNumber

string

 

3.1.28. .status.operationHistory

설명
OperationHistory는 이 호스트에서 수행된 작업에 대한 정보를 보유합니다.
유형
object
Expand
속성유형설명

프로비저닝 해제

object

OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.

inspect

object

OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.

프로비저닝

object

OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.

등록

object

OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.

3.1.29. .status.operationHistory.deprovision

설명
OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.
유형
object
Expand
속성유형설명

end

``

 

start

``

 

3.1.30. .status.operationHistory.inspect

설명
OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.
유형
object
Expand
속성유형설명

end

``

 

start

``

 

3.1.31. .status.operationHistory.provision

설명
OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.
유형
object
Expand
속성유형설명

end

``

 

start

``

 

3.1.32. .status.operationHistory.register

설명
OperationMetric에는 메트릭을 추적하는 데 사용되는 작업(검사, 프로비저닝 등)에 대한 메타데이터가 포함되어 있습니다.
유형
object
Expand
속성유형설명

end

``

 

start

``

 

3.1.33. .status.provisioning

설명
프로비저너가 추적하는 정보입니다.
유형
object
필수 항목
  • ID
  • 상태
Expand
속성유형설명

ID

string

기본 프로비저닝 툴의 시스템의 UUID

bootMode

string

bootMode는 노드를 프로비저닝하는 데 사용되는 부팅 모드를 나타냅니다.

customDeploy

object

호스트에 적용된 사용자 정의 배포 절차.

펌웨어

object

사용자가 설정한 BIOS

image

object

이미지에는 호스트에 성공적으로 프로비저닝된 마지막 이미지의 세부 정보가 있습니다.

RAID

object

사용자가 설정한 Raid

rootDeviceHints

object

사용자가 설정한 RootDevicehints

상태

string

프로비저너가 호스트로 무엇을 하는지에 대한 지표입니다.

3.1.34. .status.provisioning.customDeploy

설명
호스트에 적용된 사용자 정의 배포 절차.
유형
object
필수 항목
  • method
Expand
속성유형설명

method

string

사용자 정의 배포 방법 이름. 이 이름은 사용된 배포 램디스크에 따라 다릅니다. 사용자 정의 배포 램디스크가 없는 경우 CustomDeploy를 사용해서는 안 됩니다.

3.1.35. .status.provisioning.firmware

설명
사용자가 설정한 BIOS
유형
object
Expand
속성유형설명

simultaneousMultithreadingEnabled

boolean

단일 물리적 프로세서 코어를 여러 논리 프로세서로 표시할 수 있습니다. 이는 다음 옵션을 지원합니다: true, false.

sriovEnabled

boolean

SR-IOV 지원을 사용하면 하이퍼바이저에서 PCI-express 장치의 가상 인스턴스를 생성하여 성능이 증가할 수 있습니다. 이는 다음 옵션을 지원합니다: true, false.

virtualizationEnabled

boolean

플랫폼 하드웨어의 가상화 지원. 이는 다음 옵션을 지원합니다: true, false.

3.1.36. .status.provisioning.image

설명
이미지에는 호스트에 성공적으로 프로비저닝된 마지막 이미지의 세부 정보가 있습니다.
유형
object
필수 항목
  • url
Expand
속성유형설명

checksum

string

체크섬은 이미지의 체크섬입니다.

checksumType

string

ChecksumType은 이미지의 체크섬 알고리즘(예: md5, sha256 또는 sha512)입니다. 체크섬에서 알고리즘을 감지하는 데 특수 값 "auto"를 사용할 수 있습니다. 누락된 경우 MD5가 사용됩니다. 의심의 여지가있는 경우 "auto"를 사용하십시오.

형식

string

DiskFormat에는 이미지 형식(raw, qcow2, …​)이 포함되어 있습니다. 원시 이미지 스트리밍을 위해 raw로 설정해야 합니다. 참고 Live-iso는 url에서 참조하는 iso가 라이브 부팅되고 디스크에 배포되지 않으며 이 경우 체크섬 옵션이 필요하지 않으며 지정된 경우 무시됩니다.

url

string

URL은 배포할 이미지의 위치입니다.

3.1.37. .status.provisioning.raid

설명
사용자가 설정한 Raid
유형
object
Expand
속성유형설명

hardwareRAIDVolumes

``

하드웨어 RAID용 논리 디스크 목록입니다. rootDeviceHints를 사용하지 않는 경우 첫 번째 볼륨은 root 볼륨입니다. 이 필드의 값을 [] 로 설정하여 모든 하드웨어 RAID 구성을 지울 수 있습니다.

SoftwareRAIDVolumes

``

소프트웨어 RAID용 논리 디스크 목록입니다. rootDeviceHints를 사용하지 않는 경우 첫 번째 볼륨은 root 볼륨입니다. HardwareRAIDVolumes가 설정된 경우 이 항목이 유효하지 않습니다. 생성된 소프트웨어 RAID 장치의 수는 1 또는 2여야 합니다. 소프트웨어 RAID 장치가 하나뿐인 경우 RAID-1이어야 합니다. 두 개가 있는 경우 첫 번째는 RAID-1이어야 하며 두 번째 항목의 RAID 수준은 0, 1 또는 1+0일 수 있습니다. 첫 번째 RAID 장치가 배포 장치가 되므로 RAID-1을 적용하면 디스크 오류가 발생할 경우 부팅되지 않은 노드로 끝날 위험이 줄어듭니다. 소프트웨어 RAID는 항상 삭제됩니다.

3.1.38. .status.provisioning.rootDeviceHints

설명
사용자가 설정한 RootDevicehints
유형
object
Expand
속성유형설명

deviceName

string

"/dev/vda" 또는 "/dev/vda"와 같은 Linux 장치 이름 또는 "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"과 같은 Linux 장치 이름입니다. 팁은 실제 값과 정확히 일치해야 합니다.

hctl

string

0:0:0:0과 같은 SCSI 버스 주소입니다. 팁은 실제 값과 정확히 일치해야 합니다.

minSizeGigabytes

integer

장치의 최소 크기(Gigabytes)입니다.

model

string

벤더별 장치 식별자입니다. 팁은 실제 값의 하위 문자열입니다.

rotational

boolean

장치가 회전 미디어를 사용해야 하는 경우 true이고, 그렇지 않으면 false입니다.

serialNumber

string

장치 일련 번호입니다. 팁은 실제 값과 정확히 일치해야 합니다.

vendor

string

장치의 공급 업체 또는 제조업체의 이름입니다. 팁은 실제 값의 하위 문자열입니다.

wwn

string

고유 스토리지 식별자입니다. 팁은 실제 값과 정확히 일치해야 합니다.

wwnVendorExtension

string

고유한 벤더 스토리지 식별자입니다. 팁은 실제 값과 정확히 일치해야 합니다.

wwnWithExtension

string

벤더 확장이 추가된 고유 스토리지 식별자입니다. 팁은 실제 값과 정확히 일치해야 합니다.

3.1.39. .status.triedCredentials

설명
프로비저닝 백엔드로 마지막 인증 정보
유형
object
Expand
속성유형설명

credentials

object

SecretReference는 시크릿 참조를 나타냅니다. 모든 네임스페이스에서 시크릿을 검색하기에 충분한 정보가 있습니다.

credentialsVersion

string

 

3.1.40. .status.triedCredentials.credentials

설명
SecretReference는 시크릿 참조를 나타냅니다. 모든 네임스페이스에서 시크릿을 검색하기에 충분한 정보가 있습니다.
유형
object
Expand
속성유형설명

name

string

이름은 시크릿 리소스를 참조하는 네임스페이스 내에서 고유합니다.

네임스페이스

string

네임스페이스는 시크릿 이름을 고유해야 하는 공간을 정의합니다.

3.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/baremetalhosts

    • GET: 종류의 BareMetalHost의 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

    • DELETE: BareMetalHost의 컬렉션 삭제
    • GET: 종류의 BareMetalHost의 오브젝트 나열
    • POST: BareMetalHost 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

    • DELETE: BareMetalHost 삭제
    • GET: 지정된 BareMetalHost 읽기
    • PATCH: 지정된 BareMetalHost를 부분적으로 업데이트
    • PUT: 지정된 BareMetalHost를 교체합니다.
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

    • GET: 지정된 BareMetalHost의 읽기 상태
    • PATCH: 지정된 BareMetalHost의 부분 업데이트 상태
    • PUT: 지정된 BareMetalHost의 상태 교체

3.2.1. /apis/metal3.io/v1alpha1/baremetalhosts

HTTP 방법
GET
설명
BareMetalHost 유형의 오브젝트 나열
Expand
표 3.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHostList schema

401 - 무단

3.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

HTTP 방법
DELETE
설명
BareMetalHost의 컬렉션 삭제
Expand
표 3.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
BareMetalHost 유형의 오브젝트 나열
Expand
표 3.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHostList schema

401 - 무단

HTTP 방법
POST
설명
BareMetalHost 생성
Expand
표 3.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 3.5. 본문 매개변수
매개변수유형설명

body

BareMetalHost 스키마

 
Expand
표 3.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

201 - 생성됨

BareMetalHost 스키마

202 - 승인됨

BareMetalHost 스키마

401 - 무단

3.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

Expand
표 3.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

BareMetalHost 이름

HTTP 방법
DELETE
설명
BareMetalHost 삭제
Expand
표 3.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 3.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 BareMetalHost 읽기
Expand
표 3.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 BareMetalHost를 부분적으로 업데이트
Expand
표 3.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 3.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 BareMetalHost를 교체
Expand
표 3.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 3.14. 본문 매개변수
매개변수유형설명

body

BareMetalHost 스키마

 
Expand
표 3.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

201 - 생성됨

BareMetalHost 스키마

401 - 무단

3.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

Expand
표 3.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

BareMetalHost 이름

HTTP 방법
GET
설명
지정된 BareMetalHost의 읽기 상태
Expand
표 3.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 BareMetalHost의 부분적으로 업데이트 상태
Expand
표 3.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 3.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 BareMetalHost의 상태 교체
Expand
표 3.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 3.21. 본문 매개변수
매개변수유형설명

body

BareMetalHost 스키마

 
Expand
표 3.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

BareMetalHost 스키마

201 - 생성됨

BareMetalHost 스키마

401 - 무단

4장. DataImage [metal3.io/v1alpha1]

설명
DataImage는 dataimages API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

DataImageSpec은 DataImage의 원하는 상태를 정의합니다.

status

object

DataImageStatus는 DataImage의 관찰 상태를 정의합니다.

4.1.1. .spec

설명
DataImageSpec은 DataImage의 원하는 상태를 정의합니다.
유형
object
필수 항목
  • url
Expand
속성유형설명

url

string

URL은 BareMetalHost에 연결할 dataImage의 주소입니다.

4.1.2. .status

설명
DataImageStatus는 DataImage의 관찰 상태를 정의합니다.
유형
object
Expand
속성유형설명

attachedImage

object

현재 연결된 DataImage

error

object

연결/연결 시 오류 수 및 메시지

lastReconciled

string

마지막 조정의 시간

4.1.3. .status.attachedImage

설명
현재 연결된 DataImage
유형
object
필수 항목
  • url
Expand
속성유형설명

url

string

 

4.1.4. .status.error

설명
연결/연결 시 오류 수 및 메시지
유형
object
필수 항목
  • count
  • message
Expand
속성유형설명

count

integer

 

message

string

 

4.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/dataimages

    • GET: 종류의 DataImage의 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages

    • DELETE: DataImage의 컬렉션 삭제
    • GET: 종류의 DataImage의 오브젝트 나열
    • POST: DataImage 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}

    • DELETE: DataImage 삭제
    • GET: 지정된 DataImage 읽기
    • PATCH: 지정된 DataImage를 부분적으로 업데이트
    • PUT: 지정된 DataImage를 교체
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status

    • GET: 지정된 DataImage의 읽기 상태
    • PATCH: 지정된 DataImage의 부분 업데이트 상태
    • PUT: 지정된 DataImage의 상태

4.2.1. /apis/metal3.io/v1alpha1/dataimages

HTTP 방법
GET
설명
DataImage 유형의 오브젝트 나열
Expand
표 4.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImageList 스키마

401 - 무단

4.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages

HTTP 방법
DELETE
설명
DataImage의 컬렉션 삭제
Expand
표 4.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
DataImage 유형의 오브젝트 나열
Expand
표 4.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImageList 스키마

401 - 무단

HTTP 방법
POST
설명
DataImage 만들기
Expand
표 4.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 4.5. 본문 매개변수
매개변수유형설명

body

DataImage 스키마

 
Expand
표 4.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

201 - 생성됨

DataImage 스키마

202 - 승인됨

DataImage 스키마

401 - 무단

4.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}

Expand
표 4.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

DataImage의 이름

HTTP 방법
DELETE
설명
데이터 이미지 삭제
Expand
표 4.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 4.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 DataImage 읽기
Expand
표 4.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 DataImage를 부분적으로 업데이트
Expand
표 4.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 4.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 DataImage를 교체
Expand
표 4.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 4.14. 본문 매개변수
매개변수유형설명

body

DataImage 스키마

 
Expand
표 4.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

201 - 생성됨

DataImage 스키마

401 - 무단

4.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/dataimages/{name}/status

Expand
표 4.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

DataImage의 이름

HTTP 방법
GET
설명
지정된 DataImage의 읽기 상태
Expand
표 4.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 DataImage의 부분적으로 업데이트 상태
Expand
표 4.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 4.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 DataImage의 상태 교체
Expand
표 4.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 4.21. 본문 매개변수
매개변수유형설명

body

DataImage 스키마

 
Expand
표 4.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

DataImage 스키마

201 - 생성됨

DataImage 스키마

401 - 무단

5장. FirmwareSchema [metal3.io/v1alpha1]

설명
FirmwareSchema는 펌웨어schemas API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

FirmwareSchemaSpec은 FirmwareSchema의 원하는 상태를 정의합니다.

5.1.1. .spec

설명
FirmwareSchemaSpec은 FirmwareSchema의 원하는 상태를 정의합니다.
유형
object
필수 항목
  • schema
Expand
속성유형설명

hardwareModel

string

이 스키마와 관련된 하드웨어 모델

hardwareVendor

string

이 스키마와 연결된 하드웨어 벤더

schema

object

펌웨어 이름 맵을 스키마에 매핑

schema{}

object

펌웨어 설정을 설명하는 추가 데이터입니다.

5.1.2. .spec.schema

설명
펌웨어 이름 맵을 스키마에 매핑
유형
object

5.1.3. .spec.schema{}

설명
펌웨어 설정을 설명하는 추가 데이터입니다.
유형
object
Expand
속성유형설명

allowable_values

배열(문자열)

Enumeration 형식 설정에 허용되는 값입니다.

attribute_type

string

설정 유형입니다.

lower_bound

integer

Integer 유형 설정의 가장 낮은 값입니다.

max_length

integer

문자열 유형 설정의 최대 길이입니다.

min_length

integer

문자열 유형 설정의 최소 길이입니다.

read_only

boolean

이 설정이 읽기 전용인지 여부입니다.

고유

boolean

이 설정의 값이 이 노드에 고유한지 여부(예: 일련 번호)

upper_bound

integer

Integer 유형 설정의 가장 높은 값입니다.

5.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/firmwareschemas

    • GET: 종류의 FirmwareSchema 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

    • DELETE: FirmwareSchema의 컬렉션 삭제
    • GET: 종류의 FirmwareSchema 오브젝트 나열
    • POST: FirmwareSchema를 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

    • DELETE: FirmwareSchema 삭제
    • GET: 지정된 FirmwareSchema 읽기
    • PATCH: 지정된 FirmwareSchema를 부분적으로 업데이트
    • PUT: 지정된 FirmwareSchema를 교체합니다.

5.2.1. /apis/metal3.io/v1alpha1/firmwareschemas

HTTP 방법
GET
설명
펌웨어Schema 유형의 오브젝트 나열
Expand
표 5.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

FirmwareSchemaList 스키마

401 - 무단

5.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

HTTP 방법
DELETE
설명
FirmwareSchema 컬렉션 삭제
Expand
표 5.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
펌웨어Schema 유형의 오브젝트 나열
Expand
표 5.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

FirmwareSchemaList 스키마

401 - 무단

HTTP 방법
POST
설명
FirmwareSchema 만들기
Expand
표 5.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 5.5. 본문 매개변수
매개변수유형설명

body

FirmwareSchema 스키마

 
Expand
표 5.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

FirmwareSchema 스키마

201 - 생성됨

FirmwareSchema 스키마

202 - 승인됨

FirmwareSchema 스키마

401 - 무단

5.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

Expand
표 5.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

FirmwareSchema의 이름

HTTP 방법
DELETE
설명
FirmwareSchema 삭제
Expand
표 5.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 5.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 FirmwareSchema 읽기
Expand
표 5.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

FirmwareSchema 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 FirmwareSchema를 부분적으로 업데이트
Expand
표 5.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 5.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

FirmwareSchema 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 FirmwareSchema를 교체합니다.
Expand
표 5.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 5.14. 본문 매개변수
매개변수유형설명

body

FirmwareSchema 스키마

 
Expand
표 5.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

FirmwareSchema 스키마

201 - 생성됨

FirmwareSchema 스키마

401 - 무단

6장. HardwareData [metal3.io/v1alpha1]

설명
HardwareData는 hardwaredata API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

HardwareDataSpec은 원하는 HardwareData 상태를 정의합니다.

6.1.1. .spec

설명
HardwareDataSpec은 원하는 HardwareData 상태를 정의합니다.
유형
object
Expand
속성유형설명

하드웨어

object

검사 중에 호스트에서 발견된 하드웨어입니다.

6.1.2. .spec.hardware

설명
검사 중에 호스트에서 발견된 하드웨어입니다.
유형
object
Expand
속성유형설명

cpu

object

CPU는 호스트에서 하나의 프로세서를 설명합니다.

펌웨어

object

펌웨어는 호스트의 펌웨어를 설명합니다.

hostname

string

 

nics

array

 

nics[]

object

NIC는 호스트의 하나의 네트워크 인터페이스를 설명합니다.

ramMebibytes

integer

 

storage

array

 

storage[]

object

스토리지는 호스트에서 하나의 스토리지 장치(디스크, SSD 등)를 설명합니다.

systemVendor

object

HardwareSystemVendor는 전체 하드웨어 시스템에 대한 세부 정보를 저장합니다.

6.1.3. .spec.hardware.cpu

설명
CPU는 호스트에서 하나의 프로세서를 설명합니다.
유형
object
Expand
속성유형설명

arch

string

 

clockMegahertz

number

ClockSpeed는 ClockSpeed의 클럭 속도입니다.

count

integer

 

플래그

배열(문자열)

 

model

string

 

6.1.4. .spec.hardware.firmware

설명
펌웨어는 호스트의 펌웨어를 설명합니다.
유형
object
Expand
속성유형설명

BIOS

object

이 펌웨어의 BIOS

6.1.5. .spec.hardware.firmware.bios

설명
이 펌웨어의 BIOS
유형
object
Expand
속성유형설명

date

string

이 BIOS의 릴리스/빌드 날짜

vendor

string

이 BIOS의 공급 업체 이름

version

string

BIOS 버전

6.1.6. .spec.hardware.nics

설명
유형
array

6.1.7. .spec.hardware.nics[]

설명
NIC는 호스트의 하나의 네트워크 인터페이스를 설명합니다.
유형
object
Expand
속성유형설명

ip

string

인터페이스의 IP 주소입니다. 해당 주소가 있는 경우 IPv4 또는 IPv6 주소가 됩니다. IPv4 및 IPv6 주소가 모두 듀얼 스택 환경에 있는 경우 각 IP가 하나씩 출력됩니다.

mac

string

장치 MAC 주소

model

string

NIC의 공급 업체 및 제품 ID (예:) "0x8086 0x1572"

name

string

네트워크 인터페이스의 이름(예: "en0")

pxe

boolean

NIC가 PXE 부팅 가능 여부

speedGbps

integer

초당 Gigabits의 장치 속도

vlanId

integer

태그되지 않은 VLAN ID

VLAN

array

사용 가능한 VLAN

vlans[]

object

VLAN은 VLAN의 이름과 ID를 나타냅니다.

6.1.8. .spec.hardware.nics[].vlans

설명
사용 가능한 VLAN
유형
array

6.1.9. .spec.hardware.nics[].vlans[]

설명
VLAN은 VLAN의 이름과 ID를 나타냅니다.
유형
object
Expand
속성유형설명

id

integer

VLANID는 12비트 802.1Q VLAN 식별자입니다.

name

string

 

6.1.10. .spec.hardware.storage

설명
유형
array

6.1.11. .spec.hardware.storage[]

설명
스토리지는 호스트에서 하나의 스토리지 장치(디스크, SSD 등)를 설명합니다.
유형
object
Expand
속성유형설명

alternateNames

배열(문자열)

디스크의 대체 Linux 장치 이름 목록(예: "/dev/sda"). 이 목록은 전체 목록이 아니며 재부팅 시 이름이 안정적이지 않을 수 있습니다.

hctl

string

장치의 SCSI 위치

model

string

하드웨어 모델

name

string

디스크의 Linux 장치 이름(예: "/dev/disk/by-path/pci-0000:01:00.0-scsi-0:2:0:0"). 이 이름은 사용 가능한 경우 재부팅 시 안정적입니다.

rotational

boolean

이 디스크가 회전 스토리지를 나타내는지 여부입니다. 이 필드는 사용에 권장되지 않습니다. 대신 'Type' 필드를 사용하는 것이 좋습니다. 이 필드는 결국 더 이상 사용되지 않습니다.

serialNumber

string

장치의 일련 번호

sizeBytes

integer

disk의 크기

type

string

장치 유형, HDD, SSD, NVME 중 하나.

vendor

string

장치 공급 업체의 이름

wwn

string

장치의 WWN

wwnVendorExtension

string

장치의 WWN 벤더 확장

wwnWithExtension

string

확장 기능이 있는 WWN

6.1.12. .spec.hardware.systemVendor

설명
HardwareSystemVendor는 전체 하드웨어 시스템에 대한 세부 정보를 저장합니다.
유형
object
Expand
속성유형설명

manufacturer

string

 

productName

string

 

serialNumber

string

 

6.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/hardwaredata

    • GET: 종류의 HardwareData의 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata

    • DELETE: HardwareData의 컬렉션 삭제
    • GET: 종류의 HardwareData의 오브젝트 나열
    • POST: HardwareData를 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}

    • DELETE: HardwareData 삭제
    • GET: 지정된 HardwareData 읽기
    • PATCH: 지정된 HardwareData를 부분적으로 업데이트
    • PUT: 지정된 HardwareData를 교체

6.2.1. /apis/metal3.io/v1alpha1/hardwaredata

HTTP 방법
GET
설명
HardwareData 유형의 개체 나열
Expand
표 6.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HardwareDataList 스키마

401 - 무단

6.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata

HTTP 방법
DELETE
설명
HardwareData 컬렉션 삭제
Expand
표 6.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
HardwareData 유형의 개체 나열
Expand
표 6.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HardwareDataList 스키마

401 - 무단

HTTP 방법
POST
설명
HardwareData 만들기
Expand
표 6.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 6.5. 본문 매개변수
매개변수유형설명

body

HardwareData 스키마

 
Expand
표 6.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HardwareData 스키마

201 - 생성됨

HardwareData 스키마

202 - 승인됨

HardwareData 스키마

401 - 무단

6.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hardwaredata/{name}

Expand
표 6.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

HardwareData의 이름

HTTP 방법
DELETE
설명
HardwareData 삭제
Expand
표 6.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 6.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 HardwareData 읽기
Expand
표 6.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HardwareData 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 HardwareData를 부분적으로 업데이트
Expand
표 6.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 6.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HardwareData 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 HardwareData를 교체
Expand
표 6.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 6.14. 본문 매개변수
매개변수유형설명

body

HardwareData 스키마

 
Expand
표 6.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HardwareData 스키마

201 - 생성됨

HardwareData 스키마

401 - 무단

7장. HostFirmwareComponents [metal3.io/v1alpha1]

설명
HostFirmwareComponents는 hostfirmwarecomponents API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

HostFirmwareComponentsSpec은 HostFirmwareComponents의 원하는 상태를 정의합니다.

status

object

HostFirmwareComponentsStatus는 HostFirmwareComponents의 관찰 상태를 정의합니다.

7.1.1. .spec

설명
HostFirmwareComponentsSpec은 HostFirmwareComponents의 원하는 상태를 정의합니다.
유형
object
필수 항목
  • 업데이트
Expand
속성유형설명

업데이트

array

 

updates[]

object

FirmwareUpdate는 펌웨어 업데이트 사양을 정의합니다.

7.1.2. .spec.updates

설명
유형
array

7.1.3. .spec.updates[]

설명
FirmwareUpdate는 펌웨어 업데이트 사양을 정의합니다.
유형
object
필수 항목
  • component
  • url
Expand
속성유형설명

component

string

 

url

string

 

7.1.4. .status

설명
HostFirmwareComponentsStatus는 HostFirmwareComponents의 관찰 상태를 정의합니다.
유형
object
Expand
속성유형설명

components

array

구성 요소는 사용 가능한 모든 펌웨어 구성 요소 및 해당 정보 목록입니다.

components[]

object

FirmwareComponentStatus는 펌웨어 구성 요소의 상태를 정의합니다.

conditions

array

스키마에 따라 사양에 저장된 업데이트가 유효한지 여부를 추적합니다.

conditions[]

object

condition에는 이 API 리소스의 현재 상태에 대한 세부 정보가 포함됩니다. --- 이 구조는 필드 경로 .status.conditions에서 배열로 직접 사용하기 위한 것입니다. 예를 들어 FooStatus struct{ // foo의 현재 상태의 관찰을 나타냅니다. // knownn .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchStrategy=merge // +listType=map // +listKey=type // +listKey=type [] omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 기타 필드 }

lastUpdated

string

상태가 마지막으로 업데이트된 시간

업데이트

array

업데이트는 이름 및 url 필드를 통해 지정된 모든 펌웨어 구성 요소의 목록입니다.

updates[]

object

FirmwareUpdate는 펌웨어 업데이트 사양을 정의합니다.

7.1.5. .status.components

설명
구성 요소는 사용 가능한 모든 펌웨어 구성 요소 및 해당 정보 목록입니다.
유형
array

7.1.6. .status.components[]

설명
FirmwareComponentStatus는 펌웨어 구성 요소의 상태를 정의합니다.
유형
object
필수 항목
  • component
  • initialVersion
Expand
속성유형설명

component

string

 

currentVersion

string

 

initialVersion

string

 

lastVersionFlashed

string

 

updatedAt

string

 

7.1.7. .status.conditions

설명
스키마에 따라 사양에 저장된 업데이트가 유효한지 여부를 추적합니다.
유형
array

7.1.8. .status.conditions[]

설명
condition에는 이 API 리소스의 현재 상태에 대한 세부 정보가 포함됩니다. --- 이 구조는 필드 경로 .status.conditions에서 배열로 직접 사용하기 위한 것입니다. 예를 들어 FooStatus struct{ // foo의 현재 상태의 관찰을 나타냅니다. // knownn .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchStrategy=merge // +listType=map // +listKey=type // +listKey=type [] omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 기타 필드 }
유형
object
필수 항목
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
속성유형설명

lastTransitionTime

string

lastTransitionTime은 마지막으로 한 상태에서 다른 상태로 전환된 시간입니다. 기본 조건이 변경된 경우여야 합니다. 이를 알 수 없는 경우 API 필드가 변경된 시간을 사용합니다.

message

string

message는 변환에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다. 빈 문자열일 수 있습니다.

observedGeneration

integer

observedGeneration은 조건에 따라 설정된 .metadata.generation을 나타냅니다. 예를 들어 .metadata.generation이 현재 12이지만 .status.conditions[x].observedGeneration이 9인 경우 현재 인스턴스 상태와 관련된 조건이 최신 상태가 아닙니다.

reason

string

이유에는 조건의 마지막 전환 이유를 나타내는 프로그래밍 식별자가 포함되어 있습니다. 특정 조건 유형의 생산자는 이 필드에 예상되는 값과 의미를 정의할 수 있으며 값이 보장된 API로 간주되는지 여부를 정의할 수 있습니다. 값은 CamelCase 문자열이어야 합니다. 이 필드는 비어 있지 않을 수 있습니다.

status

string

조건의 상태, True, False, 알 수 없음.

type

string

CamelCase 또는 foo.example.com/CamelCase의 조건 유형. --- many .condition.type 값은 Available와 같은 리소스 간에 일관되지만 임의의 조건이 유용할 수 있으므로 (.node.status.conditions 참조), deconflict 기능이 중요합니다. 정규 표현식이 일치하는 정규 표현식은 (dns1123SubdomainFmt/)?(qualifiedNameFmt)입니다.

7.1.9. .status.updates

설명
업데이트는 이름 및 url 필드를 통해 지정된 모든 펌웨어 구성 요소의 목록입니다.
유형
array

7.1.10. .status.updates[]

설명
FirmwareUpdate는 펌웨어 업데이트 사양을 정의합니다.
유형
object
필수 항목
  • component
  • url
Expand
속성유형설명

component

string

 

url

string

 

7.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/hostfirmwarecomponents

    • GET: 종류의 HostFirmwareComponents 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

    • DELETE: HostFirmwareComponents 컬렉션 삭제
    • GET: 종류의 HostFirmwareComponents 오브젝트 나열
    • POST: HostFirmwareComponents 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

    • DELETE: HostFirmwareComponents 삭제
    • GET: 지정된 HostFirmwareComponents 읽기
    • PATCH: 지정된 HostFirmwareComponents를 부분적으로 업데이트
    • PUT: 지정된 HostFirmwareComponents를 교체
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

    • GET: 지정된 HostFirmwareComponents의 읽기 상태
    • PATCH: 지정된 HostFirmwareComponents의 부분적으로 업데이트 상태
    • PUT: 지정된 HostFirmwareComponents의 상태 교체

7.2.1. /apis/metal3.io/v1alpha1/hostfirmwarecomponents

HTTP 방법
GET
설명
HostFirmwareComponents 유형의 오브젝트 나열
Expand
표 7.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponentsList schema

401 - 무단

7.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents

HTTP 방법
DELETE
설명
HostFirmwareComponents 컬렉션 삭제
Expand
표 7.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
HostFirmwareComponents 유형의 오브젝트 나열
Expand
표 7.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponentsList schema

401 - 무단

HTTP 방법
POST
설명
HostFirmwareComponents 생성
Expand
표 7.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.5. 본문 매개변수
매개변수유형설명

body

HostFirmwareComponents 스키마

 
Expand
표 7.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

201 - 생성됨

HostFirmwareComponents 스키마

202 - 승인됨

HostFirmwareComponents 스키마

401 - 무단

7.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}

Expand
표 7.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

HostFirmwareComponents 이름

HTTP 방법
DELETE
설명
delete HostFirmwareComponents
Expand
표 7.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 7.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 HostFirmwareComponents 읽기
Expand
표 7.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 HostFirmwareComponents를 부분적으로 업데이트
Expand
표 7.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 HostFirmwareComponents를 교체
Expand
표 7.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.14. 본문 매개변수
매개변수유형설명

body

HostFirmwareComponents 스키마

 
Expand
표 7.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

201 - 생성됨

HostFirmwareComponents 스키마

401 - 무단

7.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwarecomponents/{name}/status

Expand
표 7.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

HostFirmwareComponents 이름

HTTP 방법
GET
설명
지정된 HostFirmwareComponents의 상태 읽기
Expand
표 7.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 HostFirmwareComponents의 부분적으로 업데이트 상태
Expand
표 7.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 HostFirmwareComponents의 상태 교체
Expand
표 7.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.21. 본문 매개변수
매개변수유형설명

body

HostFirmwareComponents 스키마

 
Expand
표 7.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareComponents 스키마

201 - 생성됨

HostFirmwareComponents 스키마

401 - 무단

8장. HostFirmwareSettings [metal3.io/v1alpha1]

설명
HostFirmwareSettings은 hostfirmwaresettings API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

HostFirmwareSettingsSpec은 HostFirmwareSettings의 원하는 상태를 정의합니다.

status

object

HostFirmwareSettingsStatus는 HostFirmwareSettings의 관찰 상태를 정의합니다.

8.1.1. .spec

설명
HostFirmwareSettingsSpec은 HostFirmwareSettings의 원하는 상태를 정의합니다.
유형
object
필수 항목
  • 설정
Expand
속성유형설명

설정

integer-or-string

설정은 이름/값 쌍으로 저장된 원하는 펌웨어 설정입니다.

8.1.2. .status

설명
HostFirmwareSettingsStatus는 HostFirmwareSettings의 관찰 상태를 정의합니다.
유형
object
필수 항목
  • 설정
Expand
속성유형설명

conditions

array

스키마에 따라 사양에 저장된 설정이 유효한지 여부를 추적합니다.

conditions[]

object

condition에는 이 API 리소스의 현재 상태에 대한 세부 정보가 포함됩니다. --- 이 구조는 필드 경로 .status.conditions에서 배열로 직접 사용하기 위한 것입니다. 예를 들어 FooStatus struct{ // foo의 현재 상태의 관찰을 나타냅니다. // knownn .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchStrategy=merge // +listType=map // +listKey=type // +listKey=type [] omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 기타 필드 }

lastUpdated

string

상태가 마지막으로 업데이트된 시간

schema

object

FirmwareSchema는 각 FirmwareSetting을 설명하는 데 사용되는 스키마에 대한 참조입니다. 기본적으로 이는 설정과 동일한 네임스페이스에 있는 스키마이지만 Spec에서 덮어쓸 수 있습니다.

설정

오브젝트(문자열)

설정은 이름/값 쌍으로 저장된 펌웨어 설정입니다.

8.1.3. .status.conditions

설명
스키마에 따라 사양에 저장된 설정이 유효한지 여부를 추적합니다.
유형
array

8.1.4. .status.conditions[]

설명
condition에는 이 API 리소스의 현재 상태에 대한 세부 정보가 포함됩니다. --- 이 구조는 필드 경로 .status.conditions에서 배열로 직접 사용하기 위한 것입니다. 예를 들어 FooStatus struct{ // foo의 현재 상태의 관찰을 나타냅니다. // knownn .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchStrategy=merge // +listType=map // +listKey=type // +listKey=type [] omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 기타 필드 }
유형
object
필수 항목
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
속성유형설명

lastTransitionTime

string

lastTransitionTime은 마지막으로 한 상태에서 다른 상태로 전환된 시간입니다. 기본 조건이 변경된 경우여야 합니다. 이를 알 수 없는 경우 API 필드가 변경된 시간을 사용합니다.

message

string

message는 변환에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다. 빈 문자열일 수 있습니다.

observedGeneration

integer

observedGeneration은 조건에 따라 설정된 .metadata.generation을 나타냅니다. 예를 들어 .metadata.generation이 현재 12이지만 .status.conditions[x].observedGeneration이 9인 경우 현재 인스턴스 상태와 관련된 조건이 최신 상태가 아닙니다.

reason

string

이유에는 조건의 마지막 전환 이유를 나타내는 프로그래밍 식별자가 포함되어 있습니다. 특정 조건 유형의 생산자는 이 필드에 예상되는 값과 의미를 정의할 수 있으며 값이 보장된 API로 간주되는지 여부를 정의할 수 있습니다. 값은 CamelCase 문자열이어야 합니다. 이 필드는 비어 있지 않을 수 있습니다.

status

string

조건의 상태, True, False, 알 수 없음.

type

string

CamelCase 또는 foo.example.com/CamelCase의 조건 유형. --- many .condition.type 값은 Available와 같은 리소스 간에 일관되지만 임의의 조건이 유용할 수 있으므로 (.node.status.conditions 참조), deconflict 기능이 중요합니다. 정규 표현식이 일치하는 정규 표현식은 (dns1123SubdomainFmt/)?(qualifiedNameFmt)입니다.

8.1.5. .status.schema

설명
FirmwareSchema는 각 FirmwareSetting을 설명하는 데 사용되는 스키마에 대한 참조입니다. 기본적으로 이는 설정과 동일한 네임스페이스에 있는 스키마이지만 Spec에서 덮어쓸 수 있습니다.
유형
object
필수 항목
  • name
  • 네임스페이스
Expand
속성유형설명

name

string

name 은 스키마에 대한 참조입니다.

네임스페이스

string

네임스페이스 는 스키마가 저장되는 네임스페이스입니다.

8.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/hostfirmwaresettings

    • GET: 종류의 HostFirmwareSettings 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

    • DELETE: HostFirmwareSettings의 컬렉션 삭제
    • GET: 종류의 HostFirmwareSettings 오브젝트 나열
    • POST: HostFirmwareSettings 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

    • DELETE: HostFirmwareSettings 삭제
    • GET: 지정된 HostFirmwareSettings 읽기
    • PATCH: 지정된 HostFirmwareSettings을 부분적으로 업데이트
    • PUT: 지정된 HostFirmwareSettings을 바꿉니다.
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

    • GET: 지정된 HostFirmwareSettings의 읽기 상태
    • PATCH: 지정된 HostFirmwareSettings의 부분적으로 업데이트 상태
    • PUT: 지정된 HostFirmwareSettings의 상태

8.2.1. /apis/metal3.io/v1alpha1/hostfirmwaresettings

HTTP 방법
GET
설명
HostFirmwareSettings 유형의 오브젝트 나열
Expand
표 8.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettingsList schema

401 - 무단

8.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

HTTP 방법
DELETE
설명
HostFirmwareSettings의 컬렉션 삭제
Expand
표 8.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
HostFirmwareSettings 유형의 오브젝트 나열
Expand
표 8.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettingsList schema

401 - 무단

HTTP 방법
POST
설명
HostFirmwareSettings 생성
Expand
표 8.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.5. 본문 매개변수
매개변수유형설명

body

HostFirmwareSettings 스키마

 
Expand
표 8.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

201 - 생성됨

HostFirmwareSettings 스키마

202 - 승인됨

HostFirmwareSettings 스키마

401 - 무단

8.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

Expand
표 8.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

HostFirmwareSettings의 이름

HTTP 방법
DELETE
설명
delete HostFirmwareSettings
Expand
표 8.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 8.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 HostFirmwareSettings 읽기
Expand
표 8.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 HostFirmwareSettings을 부분적으로 업데이트
Expand
표 8.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 HostFirmwareSettings을 바꿉니다.
Expand
표 8.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.14. 본문 매개변수
매개변수유형설명

body

HostFirmwareSettings 스키마

 
Expand
표 8.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

201 - 생성됨

HostFirmwareSettings 스키마

401 - 무단

8.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

Expand
표 8.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

HostFirmwareSettings의 이름

HTTP 방법
GET
설명
지정된 HostFirmwareSettings의 읽기 상태
Expand
표 8.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 HostFirmwareSettings의 부분적으로 업데이트 상태
Expand
표 8.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 HostFirmwareSettings의 상태 교체
Expand
표 8.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.21. 본문 매개변수
매개변수유형설명

body

HostFirmwareSettings 스키마

 
Expand
표 8.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

HostFirmwareSettings 스키마

201 - 생성됨

HostFirmwareSettings 스키마

401 - 무단

9장. Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]

설명
Metal3Remediation은 metal3remediations API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Metal3RemediationSpec은 원하는 Metal3Remediation 상태를 정의합니다.

status

object

Metal3RemediationStatus는 Metal3Remediation의 관찰 상태를 정의합니다.

9.1.1. .spec

설명
Metal3RemediationSpec은 원하는 Metal3Remediation 상태를 정의합니다.
유형
object
Expand
속성유형설명

전략

object

strategy 필드는 수정 전략을 정의합니다.

9.1.2. .spec.strategy

설명
strategy 필드는 수정 전략을 정의합니다.
유형
object
Expand
속성유형설명

retryLimit

integer

최대 수정 재시도 횟수를 설정합니다.

timeout

string

수정 재시도 사이에 시간 제한을 설정합니다.

type

string

수정 유형.

9.1.3. .status

설명
Metal3RemediationStatus는 Metal3Remediation의 관찰 상태를 정의합니다.
유형
object
Expand
속성유형설명

lastRemediated

string

LastRemediated는 호스트가 마지막으로 수정된 시기를 식별합니다.

phase

string

단계(Step)는 머신 수정의 현재 단계를 나타냅니다. 예: 보류 중, 실행 중, 완료 등

retryCount

integer

RetryCount는 수정 중에 카운터로 사용할 수 있습니다. 필드는 재부팅 횟수 등을 보유할 수 있습니다.

9.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations

    • GET: 종류의 Metal3Remediation 오브젝트 나열
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations

    • DELETE: Metal3Remediation 컬렉션 삭제
    • GET: 종류의 Metal3Remediation 오브젝트 나열
    • POST: Metal3Remediation 생성
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}

    • DELETE: Metal3Remediation 삭제
    • GET: 지정된 Metal3Remediation 읽기
    • PATCH: 지정된 Metal3Remediation을 부분적으로 업데이트합니다.
    • PUT: 지정된 Metal3Remediation을 교체합니다.
  • /APIs/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediations/{name}/status

    • GET: 지정된 Metal3Remediation의 읽기 상태
    • PATCH: 지정된 Metal3Remediation의 부분적으로 업데이트
    • PUT: 지정된 Metal3Remediation의 상태 교체

9.2.1. /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediations

HTTP 방법
GET
설명
type Metal3Remediation의 오브젝트 나열
Expand
표 9.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationList 스키마

401 - 무단

HTTP 방법
DELETE
설명
Metal3Remediation 컬렉션 삭제
Expand
표 9.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
type Metal3Remediation의 오브젝트 나열
Expand
표 9.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationList 스키마

401 - 무단

HTTP 방법
POST
설명
Metal3Remediation 생성
Expand
표 9.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 9.5. 본문 매개변수
매개변수유형설명

body

Metal3Remediation 스키마

 
Expand
표 9.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

201 - 생성됨

Metal3Remediation 스키마

202 - 승인됨

Metal3Remediation 스키마

401 - 무단

Expand
표 9.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

Metal3Remediation의 이름

HTTP 방법
DELETE
설명
Metal3Remediation 삭제
Expand
표 9.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 9.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 Metal3Remediation 읽기
Expand
표 9.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 Metal3Remediation을 부분적으로 업데이트
Expand
표 9.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 9.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 Metal3Remediation을 교체
Expand
표 9.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 9.14. 본문 매개변수
매개변수유형설명

body

Metal3Remediation 스키마

 
Expand
표 9.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

201 - 생성됨

Metal3Remediation 스키마

401 - 무단

Expand
표 9.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

Metal3Remediation의 이름

HTTP 방법
GET
설명
지정된 Metal3Remediation의 읽기 상태
Expand
표 9.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 Metal3Remediation의 상태를 부분적으로 업데이트
Expand
표 9.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 9.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 Metal3Remediation의 상태 교체
Expand
표 9.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 9.21. 본문 매개변수
매개변수유형설명

body

Metal3Remediation 스키마

 
Expand
표 9.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3Remediation 스키마

201 - 생성됨

Metal3Remediation 스키마

401 - 무단

10장. Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]

설명
Metal3RemediationTemplate은 metal3remediationtemplates API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Metal3RemediationTemplateSpec은 원하는 Metal3RemediationTemplate 상태를 정의합니다.

status

object

Metal3RemediationTemplateStatus는 Metal3RemediationTemplate의 상태를 정의합니다.

10.1.1. .spec

설명
Metal3RemediationTemplateSpec은 원하는 Metal3RemediationTemplate 상태를 정의합니다.
유형
object
필수 항목
  • 템플릿
Expand
속성유형설명

템플릿

object

Metal3RemediationTemplateResource는 템플릿에서 Metal3Remediation을 생성하는 데 필요한 데이터를 설명합니다.

10.1.2. .spec.template

설명
Metal3RemediationTemplateResource는 템플릿에서 Metal3Remediation을 생성하는 데 필요한 데이터를 설명합니다.
유형
object
필수 항목
  • spec
Expand
속성유형설명

spec

object

spec은 Metal3Remediation의 원하는 동작의 사양입니다.

10.1.3. .spec.template.spec

설명
spec은 Metal3Remediation의 원하는 동작의 사양입니다.
유형
object
Expand
속성유형설명

전략

object

strategy 필드는 수정 전략을 정의합니다.

10.1.4. .spec.template.spec.strategy

설명
strategy 필드는 수정 전략을 정의합니다.
유형
object
Expand
속성유형설명

retryLimit

integer

최대 수정 재시도 횟수를 설정합니다.

timeout

string

수정 재시도 사이에 시간 제한을 설정합니다.

type

string

수정 유형.

10.1.5. .status

설명
Metal3RemediationTemplateStatus는 Metal3RemediationTemplate의 상태를 정의합니다.
유형
object
필수 항목
  • status
Expand
속성유형설명

status

object

Metal3RemediationStatus는 Metal3Remediation의 관찰 상태를 정의합니다.

10.1.6. .status.status

설명
Metal3RemediationStatus는 Metal3Remediation의 관찰 상태를 정의합니다.
유형
object
Expand
속성유형설명

lastRemediated

string

LastRemediated는 호스트가 마지막으로 수정된 시기를 식별합니다.

phase

string

단계(Step)는 머신 수정의 현재 단계를 나타냅니다. 예: 보류 중, 실행 중, 완료 등

retryCount

integer

RetryCount는 수정 중에 카운터로 사용할 수 있습니다. 필드는 재부팅 횟수 등을 보유할 수 있습니다.

10.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

    • GET: Metal3RemediationTemplate 유형의 오브젝트 나열
  • /APIs/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates

    • DELETE: Metal3RemediationTemplate의 컬렉션 삭제
    • GET: Metal3RemediationTemplate 유형의 오브젝트 나열
    • POST: Metal3RemediationTemplate 생성
  • /APIs/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}

    • DELETE: Metal3RemediationTemplate 삭제
    • GET: 지정된 Metal3RemediationTemplate 읽기
    • PATCH: 지정된 Metal3RemediationTemplate 부분적으로 업데이트
    • PUT: 지정된 Metal3RemediationTemplate을 교체합니다.
  • /APIs/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status

    • GET: 지정된 Metal3RemediationTemplate의 읽기 상태
    • PATCH: 지정된 Metal3RemediationTemplate의 부분 업데이트 상태
    • PUT: 지정된 Metal3RemediationTemplate의 상태 교체

10.2.1. /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

HTTP 방법
GET
설명
Metal3RemediationTemplate 유형의 오브젝트 나열
Expand
표 10.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplateList schema

401 - 무단

HTTP 방법
DELETE
설명
Metal3RemediationTemplate 컬렉션 삭제
Expand
표 10.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
Metal3RemediationTemplate 유형의 오브젝트 나열
Expand
표 10.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplateList schema

401 - 무단

HTTP 방법
POST
설명
Metal3RemediationTemplate 생성
Expand
표 10.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 10.5. 본문 매개변수
매개변수유형설명

body

Metal3RemediationTemplate 스키마

 
Expand
표 10.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

201 - 생성됨

Metal3RemediationTemplate 스키마

202 - 승인됨

Metal3RemediationTemplate 스키마

401 - 무단

Expand
표 10.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

Metal3RemediationTemplate의 이름

HTTP 방법
DELETE
설명
Metal3RemediationTemplate 삭제
Expand
표 10.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 10.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 Metal3RemediationTemplate 읽기
Expand
표 10.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 Metal3RemediationTemplate 부분적으로 업데이트
Expand
표 10.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 10.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 Metal3RemediationTemplate을 교체
Expand
표 10.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 10.14. 본문 매개변수
매개변수유형설명

body

Metal3RemediationTemplate 스키마

 
Expand
표 10.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

201 - 생성됨

Metal3RemediationTemplate 스키마

401 - 무단

Expand
표 10.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

Metal3RemediationTemplate의 이름

HTTP 방법
GET
설명
지정된 Metal3RemediationTemplate의 읽기 상태
Expand
표 10.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 Metal3RemediationTemplate의 상태를 부분적으로 업데이트
Expand
표 10.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 10.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 Metal3RemediationTemplate의 상태 교체
Expand
표 10.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 10.21. 본문 매개변수
매개변수유형설명

body

Metal3RemediationTemplate 스키마

 
Expand
표 10.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

Metal3RemediationTemplate 스키마

201 - 생성됨

Metal3RemediationTemplate 스키마

401 - 무단

11장. PreprovisioningImage [metal3.io/v1alpha1]

설명
PreprovisioningImage는 사전 프로비저닝 API의 스키마입니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

PreprovisioningImageSpec은 PreprovisioningImage의 원하는 상태를 정의합니다.

status

object

PreprovisioningImageStatus는 PreprovisioningImage의 관찰 상태를 정의합니다.

11.1.1. .spec

설명
PreprovisioningImageSpec은 PreprovisioningImage의 원하는 상태를 정의합니다.
유형
object
Expand
속성유형설명

acceptFormats

배열(문자열)

acceptFormats는 허용 가능한 이미지 형식 목록입니다.

아키텍처

string

아키텍처는 이미지를 빌드하는 프로세서 아키텍처입니다.

networkDataName

string

networkDataName은 이미지에 빌드할 네트워크 데이터가 포함된 로컬 네임스페이스의 Secret 이름입니다.

11.1.2. .status

설명
PreprovisioningImageStatus는 PreprovisioningImage의 관찰 상태를 정의합니다.
유형
object
Expand
속성유형설명

아키텍처

string

아키텍처는 이미지가 빌드되는 프로세서 아키텍처입니다.

conditions

array

조건은 빌드된 이미지의 상태를 설명합니다.

conditions[]

object

condition에는 이 API 리소스의 현재 상태에 대한 세부 정보가 포함됩니다. --- 이 구조는 필드 경로 .status.conditions에서 배열로 직접 사용하기 위한 것입니다. 예를 들어 FooStatus struct{ // foo의 현재 상태의 관찰을 나타냅니다. // knownn .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchStrategy=merge // +listType=map // +listKey=type // +listKey=type [] omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 기타 필드 }

extraKernelParams

string

extraKernelParams는 네트워크를 통해 이미지를 부팅할 때 커널에 전달할 추가 매개 변수가 있는 문자열입니다. initrd 이미지에만 적합합니다.

형식

string

format은 다운로드 URL에서 사용할 수 있는 이미지 유형입니다: iso 또는 initrd.

imageUrl

string

ImageUrl은 빌드된 이미지를 다운로드할 수 있는 URL입니다.

kernelUrl

string

kernelUrl은 이미지의 커널을 다운로드할 수 있는 URL입니다. initrd 이미지에만 적합합니다.

networkData

object

networkData는 이미지를 빌드하는 데 사용되는 네트워크 데이터가 포함된 보안 버전에 대한 참조입니다.

11.1.3. .status.conditions

설명
조건은 빌드된 이미지의 상태를 설명합니다.
유형
array

11.1.4. .status.conditions[]

설명
condition에는 이 API 리소스의 현재 상태에 대한 세부 정보가 포함됩니다. --- 이 구조는 필드 경로 .status.conditions에서 배열로 직접 사용하기 위한 것입니다. 예를 들어 FooStatus struct{ // foo의 현재 상태의 관찰을 나타냅니다. // knownn .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchStrategy=merge // +listType=map // +listKey=type // +listKey=type [] omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 기타 필드 }
유형
object
필수 항목
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
속성유형설명

lastTransitionTime

string

lastTransitionTime은 마지막으로 한 상태에서 다른 상태로 전환된 시간입니다. 기본 조건이 변경된 경우여야 합니다. 이를 알 수 없는 경우 API 필드가 변경된 시간을 사용합니다.

message

string

message는 변환에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다. 빈 문자열일 수 있습니다.

observedGeneration

integer

observedGeneration은 조건에 따라 설정된 .metadata.generation을 나타냅니다. 예를 들어 .metadata.generation이 현재 12이지만 .status.conditions[x].observedGeneration이 9인 경우 현재 인스턴스 상태와 관련된 조건이 최신 상태가 아닙니다.

reason

string

이유에는 조건의 마지막 전환 이유를 나타내는 프로그래밍 식별자가 포함되어 있습니다. 특정 조건 유형의 생산자는 이 필드에 예상되는 값과 의미를 정의할 수 있으며 값이 보장된 API로 간주되는지 여부를 정의할 수 있습니다. 값은 CamelCase 문자열이어야 합니다. 이 필드는 비어 있지 않을 수 있습니다.

status

string

조건의 상태, True, False, 알 수 없음.

type

string

CamelCase 또는 foo.example.com/CamelCase의 조건 유형. --- many .condition.type 값은 Available와 같은 리소스 간에 일관되지만 임의의 조건이 유용할 수 있으므로 (.node.status.conditions 참조), deconflict 기능이 중요합니다. 정규 표현식이 일치하는 정규 표현식은 (dns1123SubdomainFmt/)?(qualifiedNameFmt)입니다.

11.1.5. .status.networkData

설명
networkData는 이미지를 빌드하는 데 사용되는 네트워크 데이터가 포함된 보안 버전에 대한 참조입니다.
유형
object
Expand
속성유형설명

name

string

 

version

string

 

11.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/preprovisioningimages

    • GET: PreprovisioningImage 유형의 오브젝트 나열
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages

    • DELETE: PreprovisioningImage의 컬렉션 삭제
    • GET: PreprovisioningImage 유형의 오브젝트 나열
    • POST: PreprovisioningImage 생성
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}

    • DELETE: PreprovisioningImage 삭제
    • GET: 지정된 PreprovisioningImage 읽기
    • PATCH: 지정된 사전 프로비저닝 이미지를 부분적으로 업데이트
    • PUT: 지정된 PreprovisioningImage를 교체
  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status

    • GET: 지정된 PreprovisioningImage의 읽기 상태
    • PATCH: 지정된 PreprovisioningImage의 부분 업데이트 상태
    • PUT: 지정된 PreprovisioningImage의 상태

11.2.1. /apis/metal3.io/v1alpha1/preprovisioningimages

HTTP 방법
GET
설명
PreprovisioningImage 유형의 오브젝트 나열
Expand
표 11.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImageList 스키마

401 - 무단

11.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages

HTTP 방법
DELETE
설명
사전 프로비저닝 이미지 컬렉션 삭제
Expand
표 11.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
PreprovisioningImage 유형의 오브젝트 나열
Expand
표 11.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImageList 스키마

401 - 무단

HTTP 방법
POST
설명
사전 프로비저닝 이미지 생성
Expand
표 11.4. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 11.5. 본문 매개변수
매개변수유형설명

body

PreprovisioningImage 스키마

 
Expand
표 11.6. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

201 - 생성됨

PreprovisioningImage 스키마

202 - 승인됨

PreprovisioningImage 스키마

401 - 무단

11.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}

Expand
표 11.7. 글로벌 경로 매개변수
매개변수유형설명

name

string

PreprovisioningImage 이름

HTTP 방법
DELETE
설명
사전 프로비저닝 이미지 삭제
Expand
표 11.8. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 11.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 PreprovisioningImage 읽기
Expand
표 11.10. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 PreprovisioningImage를 부분적으로 업데이트
Expand
표 11.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 11.12. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 PreprovisioningImage를 교체
Expand
표 11.13. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 11.14. 본문 매개변수
매개변수유형설명

body

PreprovisioningImage 스키마

 
Expand
표 11.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

201 - 생성됨

PreprovisioningImage 스키마

401 - 무단

11.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status

Expand
표 11.16. 글로벌 경로 매개변수
매개변수유형설명

name

string

PreprovisioningImage 이름

HTTP 방법
GET
설명
지정된 PreprovisioningImage의 읽기 상태
Expand
표 11.17. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 PreprovisioningImage의 부분적으로 업데이트 상태
Expand
표 11.18. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 11.19. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 PreprovisioningImage의 상태 교체
Expand
표 11.20. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 11.21. 본문 매개변수
매개변수유형설명

body

PreprovisioningImage 스키마

 
Expand
표 11.22. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

PreprovisioningImage 스키마

201 - 생성됨

PreprovisioningImage 스키마

401 - 무단

12장. 프로비저닝 [metal3.io/v1alpha1]

설명
프로비저닝에는 프로비저닝 서비스(Ironic)에서 baremetal 호스트를 프로비저닝하는 데 사용하는 구성이 포함되어 있습니다. 프로비저닝은 프로비저닝 네트워크에 대한 정보와 PXE 부팅에 사용할 수 있는 서버의 NIC에 대한 admin 또는 사용자가 제공한 OpenShift 설치 프로그램에 의해 생성됩니다. 이 CR은 설치 프로그램에서 생성한 싱글톤이며 현재 metal3 클러스터에서 컨테이너를 가져오고 업데이트하기 위해 cluster-baremetal-operator에서만 사용합니다.
유형
object

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

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ProvisioningSpec은 원하는 프로비저닝 상태를 정의합니다.

status

object

ProvisioningStatus는 Provisioning의 관찰 상태를 정의합니다.

12.1.1. .spec

설명
ProvisioningSpec은 원하는 프로비저닝 상태를 정의합니다.
유형
object
Expand
속성유형설명

bootIsoSource

string

BootIsoSource는 iso 이미지가 노드를 부팅할 위치를 설정하는 방법을 제공합니다. 기본적으로 부팅 iso 이미지는 로컬에 캐시되고 보조 httpd 서버를 사용하여 프로비저닝 서비스(Ironic) 노드에서 제공됩니다. iso 이미지가 httpd 서버에서 이미 제공되는 경우 이 옵션을 http로 설정하면 이미지를 직접 제공할 수 있습니다. 이 경우 부팅을 호스팅하는 httpd 서버가 metal3 pod에서 액세스할 수 있어야 하는 네트워크(내부 또는 외부)입니다.

disableVirtualMediaTLS

boolean

DisableVirtualMediaTLS는 가상 미디어 서버에서 TLS를 끕니다. 이 서버는 HTTPS 링크를 수락할 수 없는 하드웨어에 필요할 수 있습니다.

preProvisioningOSDownloadURLs

object

PreprovisioningOSDownloadURLs는 가상 미디어 또는 PXE를 사용하여 작업자를 프로비저닝하는 데 필요한 CoreOS Live URL 세트입니다.

provisioningDHCPExternal

boolean

ProvisioningDHCPExternal는 provisioning DHCP 범위의 IP 주소에 대한 DHCP 서버가 metal3 클러스터 내에 있는지 또는 외부에 있는지 여부를 나타냅니다. 이 필드는 provisioningNetwork 대신 더 이상 사용되지 않습니다.

provisioningDHCPRange

string

provisioningDHCPRange는 ProvisioningDHCPExternal와 함께 해석되어야 합니다. provisioningDHCPExternal의 값이 False로 설정된 경우 ProvisioningDHCPRange는 baremetal 서버를 프로비저닝하는 동안 metal3 클러스터 내에서 실행 중인 DHCP 서버에서 사용할 수 있는 IP 주소 범위를 나타냅니다. ProvisioningDHCPExternal 값을 True로 설정하면 ProvisioningDHCPRange 값이 무시됩니다. ProvisioningDHCPExternal의 값이 False로 설정되어 내부 DHCP 서버와 ProvisioningDHCPRange 값을 나타내는 경우 DHCP 범위는 ProvisioningNetworkCIDR의 .10에서 .100으로 이동하는 기본 범위로 간주됩니다. 이는 설치 프로그램에서 CR을 생성한 후 변경할 수 있는 모든 프로비저닝 구성의 유일한 값입니다. 이 값은 ProvisioningNetworkCIDR 내에서 쉼표로 구분된 IP 주소여야 합니다. 여기서 첫 번째 주소는 범위 시작을 나타내며 두 번째 주소는 범위에서 마지막으로 사용 가능한 주소를 나타냅니다.

provisioningDNS

boolean

ProvisioningDNS를 사용하면 provisionig 네트워크에서 DHCP를 통해 DNS 정보를 보낼 수 있습니다. 프로비저닝 서비스 자체(Ironic)에는 DNS가 필요하지 않지만 계층화된 제품(예: ZTP)에 유용할 수 있으므로 기본적으로 꺼져 있습니다.

provisioningIP

string

provisioningIP는 baremetal 서버의 provisioningInterface에 할당된 IP 주소입니다. 이 IP 주소는 프로비저닝 서브넷 내에 있어야 하며 DHCP 범위 외부에 있어야 합니다.

provisioningInterface

string

provisioningInterface는 provisioning 네트워크에 대한 baremetal 서버의 네트워크 인터페이스 이름입니다. eth1 또는 ens3과 같은 값을 가질 수 있습니다.

provisioningMacAddresses

배열(문자열)

provisioningMacAddresses는 provisioning 네트워크에 대한 baremetal 서버의 네트워크 인터페이스의 mac 주소 목록입니다. ProvisioningInterface 대신 이를 사용하여 다른 이름의 인터페이스를 허용합니다. 제공되지 않으면 각 마스터의 BMH.Spec.BootMacAddress에 의해 채워집니다.

provisioningNetwork

string

provisioningNetwork는 provisioning 네트워크에 대한 기본 네트워크 구성의 상태를 나타내는 방법을 제공합니다. 이 필드에는 베어 메탈 IPI 솔루션이 프로비저닝 네트워크를 완전히 관리하는 경우 Managed값 중 하나가 있을 수 있습니다. Unmanaged- 프로젝션 네트워크가 있고 사용되지만 사용자가 DHCP를 관리해야 하는 경우입니다. 가상 미디어의 프로비저닝이 권장되지만 필요한 경우 PXE를 계속 사용할 수 있습니다. Disabled- 프로비저닝 네트워크가 완전히 비활성화된 경우입니다. 사용자는 가상 미디어 또는 지원 설치를 사용하여 baremetal 클러스터를 가져올 수 있습니다. metal3을 전원 관리에 사용하는 경우 시스템 네트워크에서 BMC에 액세스할 수 있어야 합니다. 사용자는 서비스 프로비저닝에 사용할 외부 네트워크에 두 개의 IP를 제공해야 합니다.

provisioningNetworkCIDR

string

provisioningNetworkCIDR는 baremetal 노드가 프로비저닝되는 네트워크입니다. dhcpRange의 provisioningIP 및 IP는 모두 이 네트워크 내에서 제공됩니다. 베어 메탈 IPI 솔루션에서 관리하는 IPv6 및 네트워크를 사용하는 경우 /64보다 큰 네트워크가 될 수 없습니다.

provisioningOSDownloadURL

string

provisioningOSDownloadURL은 OS 이미지가 baremetal 호스트 머신을 부팅하는 데 사용되는 위치입니다. metal3 클러스터에서 다운로드할 수 있습니다.

virtualMediaViaExternalNetwork

boolean

"true"로 설정할 때 virtualMediaViaExternalNetwork 플래그를 사용하면 작업자가 가상 미디어를 통해 부팅하고 외부 네트워크를 통해 metal3에 연결할 수 있습니다. 플래그가 "false"(기본값)로 설정된 경우에도 Managed 모드에서 외부 네트워크 및 프로비저닝 네트워크를 통해 Disabled 모드에서, 프로비저닝 네트워크를 통해 ProvisioningNetwork에 지정된 구성에 따라 가상 미디어 배포가 계속 발생할 수 있습니다. PXE 배포는 항상 프로비저닝 네트워크를 사용하며 이 플래그의 영향을 받지 않습니다.

watchAllNamespaces

boolean

watchAllNameSpaces는 모든 네임스페이스에서 이 프로비저닝 구성을 명시적으로 사용할 수 있는 방법을 제공합니다. 기본값은 false로 설정되며 해당 상태에서는 openshift-machine-api 네임스페이스에서만 baremetal 호스트를 프로비저닝하는 데 사용됩니다. true로 설정하면 이 프로비저닝 구성이 모든 네임스페이스의 baremetal 호스트에 사용됩니다.

12.1.2. .spec.preProvisioningOSDownloadURLs

설명
PreprovisioningOSDownloadURLs는 가상 미디어 또는 PXE를 사용하여 작업자를 프로비저닝하는 데 필요한 CoreOS Live URL 세트입니다.
유형
object
Expand
속성유형설명

initramfsURL

string

PXE 배포에 사용할 InitramfsURL 이미지 URL

isoURL

string

라이브 ISO 배포에 사용할 IsoURL 이미지 URL

kernelURL

string

KernelURL은 PXE 배포에 사용할 이미지 URL입니다.

rootfsURL

string

PXE 배포에 사용할 RootfsURL 이미지 URL

12.1.3. .status

설명
ProvisioningStatus는 Provisioning의 관찰 상태를 정의합니다.
유형
object
Expand
속성유형설명

conditions

array

conditions는 조건 및 상태 목록입니다.

conditions[]

object

OperatorCondition은 표준 조건 필드입니다.

생성

array

세대는 항목이 조정되어야 하거나 반응이 필요한 방식으로 변경된 시기를 결정하는 데 사용됩니다.

generations[]

object

GenerationStatus는 지정된 리소스의 생성을 추적하여 강제 업데이트에 대한 결정을 내릴 수 있습니다.

observedGeneration

integer

observedGeneration은 귀하가 다루는 마지막 세대의 변경 사항입니다.

readyReplicas

integer

readyReplicas는 준비된 복제본 수와 원하는 상태를 나타냅니다.

version

string

버전이 이 가용성이 적용되는 수준입니다.

12.1.4. .status.conditions

설명
conditions는 조건 및 상태 목록입니다.
유형
array

12.1.5. .status.conditions[]

설명
OperatorCondition은 표준 조건 필드입니다.
유형
object
Expand
속성유형설명

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

12.1.6. .status.generations

설명
세대는 항목이 조정되어야 하거나 반응이 필요한 방식으로 변경된 시기를 결정하는 데 사용됩니다.
유형
array

12.1.7. .status.generations[]

설명
GenerationStatus는 지정된 리소스의 생성을 추적하여 강제 업데이트에 대한 결정을 내릴 수 있습니다.
유형
object
Expand
속성유형설명

group

string

그룹은 추적 중인 항목의 그룹입니다.

hash

string

hash는 시크릿 및 configmaps와 같이 민감한 콘텐츠인 생성이 없는 리소스에 대해 설정된 선택적 필드입니다.

lastGeneration

integer

lastGeneration은 관련된 워크로드 컨트롤러의 마지막 생성입니다.

name

string

추적 중인 항목의 이름입니다.Is the name of the item you are tracking

네임스페이스

string

namespace is where you're tracking is where you're tracking is where you're tracking is where you're tracking

resource

string

리소스는 추적 중인 항목의 리소스 유형입니다.

12.2. API 끝점

다음 API 끝점을 사용할 수 있습니다.

  • /apis/metal3.io/v1alpha1/provisionings

    • DELETE: Provisioning 컬렉션 삭제
    • GET: 프로비저닝 유형의 오브젝트 나열
    • POST: 프로비저닝 생성
  • /apis/metal3.io/v1alpha1/provisionings/{name}

    • DELETE: Provisioning 삭제
    • GET: 지정된 프로비저닝 읽기
    • PATCH: 지정된 프로비저닝을 부분적으로 업데이트
    • PUT: 지정된 프로비저닝을 교체
  • /apis/metal3.io/v1alpha1/provisionings/{name}/status

    • GET: 지정된 프로비저닝의 읽기 상태
    • PATCH: 지정된 프로비저닝의 부분 업데이트 상태
    • PUT: 지정된 프로비저닝의 상태

12.2.1. /apis/metal3.io/v1alpha1/provisionings

HTTP 방법
DELETE
설명
프로비저닝 컬렉션 삭제
Expand
표 12.1. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
프로비저닝 유형의 오브젝트 나열
Expand
표 12.2. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ProvisioningList 스키마

401 - 무단

HTTP 방법
POST
설명
프로비저닝 생성
Expand
표 12.3. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 12.4. 본문 매개변수
매개변수유형설명

body

프로비저닝 스키마

 
Expand
표 12.5. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

201 - 생성됨

프로비저닝 스키마

202 - 승인됨

프로비저닝 스키마

401 - 무단

12.2.2. /apis/metal3.io/v1alpha1/provisionings/{name}

Expand
표 12.6. 글로벌 경로 매개변수
매개변수유형설명

name

string

프로비저닝 이름

HTTP 방법
DELETE
설명
프로비저닝 삭제
Expand
표 12.7. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

Expand
표 12.8. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 프로비저닝 읽기
Expand
표 12.9. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 프로비저닝을 부분적으로 업데이트
Expand
표 12.10. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 12.11. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 프로비저닝을 교체
Expand
표 12.12. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 12.13. 본문 매개변수
매개변수유형설명

body

프로비저닝 스키마

 
Expand
표 12.14. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

201 - 생성됨

프로비저닝 스키마

401 - 무단

12.2.3. /apis/metal3.io/v1alpha1/provisionings/{name}/status

Expand
표 12.15. 글로벌 경로 매개변수
매개변수유형설명

name

string

프로비저닝 이름

HTTP 방법
GET
설명
지정된 프로비저닝의 읽기 상태
Expand
표 12.16. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 프로비저닝의 부분적으로 업데이트 상태
Expand
표 12.17. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 12.18. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 프로비저닝의 상태 교체
Expand
표 12.19. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 12.20. 본문 매개변수
매개변수유형설명

body

프로비저닝 스키마

 
Expand
표 12.21. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

프로비저닝 스키마

201 - 생성됨

프로비저닝 스키마

401 - 무단

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은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2025 Red Hat