Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us


Specification

Property Type Description

.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/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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

.spec

object

ReplicaSetSpec is the specification of a ReplicaSet.

.status

object

ReplicaSetStatus represents the current status of a ReplicaSet.

.spec
Description

ReplicaSetSpec is the specification of a ReplicaSet.

Type

object

Required
  • selector

Property Type Description

minReadySeconds

integer

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

replicas

integer

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

selector

LabelSelector meta/v1

Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

template

PodTemplateSpec core/v1

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

.status
Description

ReplicaSetStatus represents the current status of a ReplicaSet.

Type

object

Required
  • replicas

Property Type Description

availableReplicas

integer

The number of available replicas (ready for at least minReadySeconds) for this replica set.

conditions

array

Represents the latest available observations of a replica set’s current state.

conditions[]

object

ReplicaSetCondition describes the state of a replica set at a certain point.

fullyLabeledReplicas

integer

The number of pods that have labels matching the labels of the pod template of the replicaset.

observedGeneration

integer

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

readyReplicas

integer

The number of ready replicas for this replica set.

replicas

integer

Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

.status.conditions
Description

Represents the latest available observations of a replica set’s current state.

Type

array

.status.conditions[]
Description

ReplicaSetCondition describes the state of a replica set at a certain point.

Type

object

Required
  • type

  • status

Property Type Description

lastTransitionTime

Time meta/v1

The last time the condition transitioned from one status to another.

message

string

A human readable message indicating details about the transition.

reason

string

The reason for the condition’s last transition.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of replica set condition.

API endpoints

The following API endpoints are available:

  • /apis/apps/v1/replicasets

    • GET: list or watch objects of kind ReplicaSet

  • /apis/apps/v1/namespaces/{namespace}/replicasets

    • DELETE: delete collection of ReplicaSet

    • GET: list or watch objects of kind ReplicaSet

    • POST: create a ReplicaSet

  • /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

    • DELETE: delete a ReplicaSet

    • GET: read the specified ReplicaSet

    • PATCH: partially update the specified ReplicaSet

    • PUT: replace the specified ReplicaSet

  • /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

    • GET: read scale of the specified ReplicaSet

    • PATCH: partially update scale of the specified ReplicaSet

    • PUT: replace scale of the specified ReplicaSet

  • /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

    • GET: read status of the specified ReplicaSet

    • PATCH: partially update status of the specified ReplicaSet

    • PUT: replace status of the specified ReplicaSet

/apis/apps/v1/replicasets

Table 1. Global guery parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty

string

If 'true', then the output is pretty printed.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

HTTP method

GET

Description

list or watch objects of kind ReplicaSet

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSetList apps/v1

401 - Unauthorized

Empty

/apis/apps/v1/namespaces/{namespace}/replicasets

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of ReplicaSet

Table 5. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind ReplicaSet

Table 7. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSetList apps/v1

401 - Unauthorized

Empty

HTTP method

POST

Description

create a ReplicaSet

Table 9. Body parameters
Parameter Type Description

body

ReplicaSet apps/v1

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

201 - Created

ReplicaSet apps/v1

202 - Accepted

ReplicaSet apps/v1

401 - Unauthorized

Empty

/apis/apps/v1/namespaces/{namespace}/replicasets/{name}

Table 11. Global path parameters
Parameter Type Description

name

string

name of the ReplicaSet

namespace

string

object name and auth scope, such as for teams and projects

Table 12. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete a ReplicaSet

Table 13. Query parameters
Parameter Type Description

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 14. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified ReplicaSet

Table 16. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. Export strips fields that a user can not specify.

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified ReplicaSet

Table 18. Body parameters
Parameter Type Description

body

Patch meta/v1

Table 19. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified ReplicaSet

Table 20. Body parameters
Parameter Type Description

body

ReplicaSet apps/v1

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

201 - Created

ReplicaSet apps/v1

401 - Unauthorized

Empty

/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

Table 22. Global path parameters
Parameter Type Description

name

string

name of the Scale

namespace

string

object name and auth scope, such as for teams and projects

Table 23. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

GET

Description

read scale of the specified ReplicaSet

Table 24. HTTP responses
HTTP code Reponse body

200 - OK

Scale autoscaling/v1

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update scale of the specified ReplicaSet

Table 25. Body parameters
Parameter Type Description

body

Patch meta/v1

Table 26. HTTP responses
HTTP code Reponse body

200 - OK

Scale autoscaling/v1

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace scale of the specified ReplicaSet

Table 27. Body parameters
Parameter Type Description

body

Scale autoscaling/v1

Table 28. HTTP responses
HTTP code Reponse body

200 - OK

Scale autoscaling/v1

201 - Created

Scale autoscaling/v1

401 - Unauthorized

Empty

/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

Table 29. Global path parameters
Parameter Type Description

name

string

name of the ReplicaSet

namespace

string

object name and auth scope, such as for teams and projects

Table 30. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

GET

Description

read status of the specified ReplicaSet

Table 31. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified ReplicaSet

Table 32. Body parameters
Parameter Type Description

body

Patch meta/v1

Table 33. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified ReplicaSet

Table 34. Body parameters
Parameter Type Description

body

ReplicaSet apps/v1

Table 35. HTTP responses
HTTP code Reponse body

200 - OK

ReplicaSet apps/v1

201 - Created

ReplicaSet apps/v1

401 - Unauthorized

Empty