이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 15. OSImageStream [machineconfiguration.openshift.io/v1alpha1]


Description

OSImageStream describes a set of streams and associated images available for the MachineConfigPools to be used as base OS images.

The resource is a singleton named "cluster".

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.

Type
object
Required
  • spec

15.1. Specification

Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec contains the desired OSImageStream config configuration.

status

object

status describes the last observed state of this OSImageStream. Populated by the MachineConfigOperator after reading release metadata. When not present, the controller has not yet reconciled this resource.

15.1.1. .spec

Description
spec contains the desired OSImageStream config configuration.
Type
object

15.1.2. .status

Description
status describes the last observed state of this OSImageStream. Populated by the MachineConfigOperator after reading release metadata. When not present, the controller has not yet reconciled this resource.
Type
object
Required
  • availableStreams
  • defaultStream
Expand
PropertyTypeDescription

availableStreams

array

availableStreams is a list of the available OS Image Streams that can be used as the base image for MachineConfigPools. availableStreams is required, must have at least one item, must not exceed 100 items, and must have unique entries keyed on the name field.

availableStreams[]

object

 

defaultStream

string

defaultStream is the name of the stream that should be used as the default when no specific stream is requested by a MachineConfigPool.

It must be a valid RFC 1123 subdomain between 1 and 253 characters in length, consisting of lowercase alphanumeric characters, hyphens ('-'), and periods ('.'), and must reference the name of one of the streams in availableStreams.

15.1.3. .status.availableStreams

Description
availableStreams is a list of the available OS Image Streams that can be used as the base image for MachineConfigPools. availableStreams is required, must have at least one item, must not exceed 100 items, and must have unique entries keyed on the name field.
Type
array

15.1.4. .status.availableStreams[]

Description
Type
object
Required
  • name
  • osExtensionsImage
  • osImage
Expand
PropertyTypeDescription

name

string

name is the required identifier of the stream.

name is determined by the operator based on the OCI label of the discovered OS or Extension Image.

Must be a valid RFC 1123 subdomain between 1 and 253 characters in length, consisting of lowercase alphanumeric characters, hyphens ('-'), and periods ('.').

osExtensionsImage

string

osExtensionsImage is a required OS Extensions Image referenced by digest.

osExtensionsImage bundles the extra repositories used to enable extensions, augmenting the base operating system without modifying the underlying immutable osImage.

The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>, where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9. The length of the whole spec must be between 1 to 447 characters.

osImage

string

osImage is a required OS Image referenced by digest.

osImage contains the immutable, fundamental operating system components, including the kernel and base utilities, that define the core environment for the node’s host operating system.

The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>, where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9. The length of the whole spec must be between 1 to 447 characters.

15.2. API endpoints

The following API endpoints are available:

  • /apis/machineconfiguration.openshift.io/v1alpha1/osimagestreams

    • DELETE: delete collection of OSImageStream
    • GET: list objects of kind OSImageStream
    • POST: create an OSImageStream
  • /apis/machineconfiguration.openshift.io/v1alpha1/osimagestreams/{name}

    • DELETE: delete an OSImageStream
    • GET: read the specified OSImageStream
    • PATCH: partially update the specified OSImageStream
    • PUT: replace the specified OSImageStream
  • /apis/machineconfiguration.openshift.io/v1alpha1/osimagestreams/{name}/status

    • GET: read status of the specified OSImageStream
    • PATCH: partially update status of the specified OSImageStream
    • PUT: replace status of the specified OSImageStream

15.2.1. /apis/machineconfiguration.openshift.io/v1alpha1/osimagestreams

HTTP method
DELETE
Description
delete collection of OSImageStream
Expand
Table 15.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind OSImageStream
Expand
Table 15.2. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStreamList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an OSImageStream
Expand
Table 15.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 15.4. Body parameters
ParameterTypeDescription

body

OSImageStream schema

 
Expand
Table 15.5. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

201 - Created

OSImageStream schema

202 - Accepted

OSImageStream schema

401 - Unauthorized

Empty

15.2.2. /apis/machineconfiguration.openshift.io/v1alpha1/osimagestreams/{name}

Expand
Table 15.6. Global path parameters
ParameterTypeDescription

name

string

name of the OSImageStream

HTTP method
DELETE
Description
delete an OSImageStream
Expand
Table 15.7. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 15.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified OSImageStream
Expand
Table 15.9. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified OSImageStream
Expand
Table 15.10. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 15.11. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified OSImageStream
Expand
Table 15.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 15.13. Body parameters
ParameterTypeDescription

body

OSImageStream schema

 
Expand
Table 15.14. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

201 - Created

OSImageStream schema

401 - Unauthorized

Empty

15.2.3. /apis/machineconfiguration.openshift.io/v1alpha1/osimagestreams/{name}/status

Expand
Table 15.15. Global path parameters
ParameterTypeDescription

name

string

name of the OSImageStream

HTTP method
GET
Description
read status of the specified OSImageStream
Expand
Table 15.16. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified OSImageStream
Expand
Table 15.17. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 15.18. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified OSImageStream
Expand
Table 15.19. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 15.20. Body parameters
ParameterTypeDescription

body

OSImageStream schema

 
Expand
Table 15.21. HTTP responses
HTTP codeReponse body

200 - OK

OSImageStream schema

201 - Created

OSImageStream schema

401 - Unauthorized

Empty

Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2026 Red Hat
맨 위로 이동