HcpOpenShiftClusterProperties interface

Package:

@azure/arm-redhatopenshifthcp

HCP cluster properties

Properties

api	Shows the cluster API server profile
autoscaling	Configure ClusterAutoscaling .
clusterImageRegistry	OpenShift internal image registry
console	Shows the cluster web console information
cryptoRestrictions	Cryptographic restrictions for kernel and userspace libraries
dns	Cluster DNS configuration
etcd	Configure ETCD.
imageDigestMirrors	imageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster.
ingress	The cluster ingress configuration
network	Cluster network configuration
nodeDrainTimeoutMinutes	nodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This is the value is used a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool
platform	Azure platform configuration
provisioningState	The status of the last operation.
status	Status of the cluster resource
version	Version of the control plane components

Property Details

api

Shows the cluster API server profile

api?: ApiProfile

Property Value

ApiProfile

autoscaling

Configure ClusterAutoscaling .

autoscaling?: ClusterAutoscalingProfile

Property Value

ClusterAutoscalingProfile

clusterImageRegistry

OpenShift internal image registry

clusterImageRegistry?: ClusterImageRegistryProfile

Property Value

ClusterImageRegistryProfile

console

Shows the cluster web console information

console?: ConsoleProfile

Property Value

ConsoleProfile

cryptoRestrictions

Cryptographic restrictions for kernel and userspace libraries

cryptoRestrictions?: string

Property Value

string

dns

Cluster DNS configuration

dns?: DnsProfile

Property Value

DnsProfile

etcd

Configure ETCD.

etcd?: EtcdProfile

Property Value

EtcdProfile

imageDigestMirrors

imageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications.

WARNING: Updating this array will redeploy all node pools in the cluster.

imageDigestMirrors?: ImageDigestMirror[]

Property Value

ImageDigestMirror[]

ingress

The cluster ingress configuration

ingress?: IngressProfile

Property Value

IngressProfile

network

Cluster network configuration

network?: NetworkProfile

Property Value

NetworkProfile

nodeDrainTimeoutMinutes

nodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades.

Valid values are in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation.

This is the value is used a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool

nodeDrainTimeoutMinutes?: number

Property Value

number

platform

Azure platform configuration

platform: PlatformProfile

Property Value

PlatformProfile

provisioningState

The status of the last operation.

provisioningState?: string

Property Value

string

status

Status of the cluster resource

status?: ResourceStatus

Property Value

ResourceStatus

version

Version of the control plane components

version: VersionProfile

Property Value

VersionProfile