v20220401

package
v0.0.0-...-37f2402 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const APIVersion = "2022-04-01"

APIVersion contains a version string as it will be used by clients

Variables

This section is empty.

Functions

func ExampleOpenShiftClusterAdminKubeconfigResponse 

func ExampleOpenShiftClusterAdminKubeconfigResponse() interface{}

ExampleOpenShiftClusterAdminKubeconfigResponse returns an example OpenShiftClusterAdminKubeconfig object that the RP might return to an end-user

func ExampleOpenShiftClusterCredentialsResponse 

func ExampleOpenShiftClusterCredentialsResponse() interface{}

ExampleOpenShiftClusterCredentialsResponse returns an example OpenShiftClusterCredentials object that the RP might return to an end-user

func ExampleOpenShiftClusterListResponse 

func ExampleOpenShiftClusterListResponse() interface{}

ExampleOpenShiftClusterListResponse returns an example OpenShiftClusterList object that the RP might return to an end-user

func ExampleOpenShiftClusterPatchParameter 

func ExampleOpenShiftClusterPatchParameter() interface{}

ExampleOpenShiftClusterPatchParameter returns an example OpenShiftCluster object that an end-user might send to create a cluster in a PATCH request

func ExampleOpenShiftClusterPutParameter 

func ExampleOpenShiftClusterPutParameter() interface{}

ExampleOpenShiftClusterPutParameter returns an example OpenShiftCluster object that an end-user might send to create a cluster in a PUT request

func ExampleOpenShiftClusterResponse 

func ExampleOpenShiftClusterResponse() interface{}

ExampleOpenShiftClusterResponse returns an example OpenShiftCluster object that the RP might return to an end-user

Types

type APIServerProfile 

type APIServerProfile struct {
	// API server visibility.
	Visibility Visibility `json:"visibility,omitempty"`

	// The URL to access the cluster API server.
	URL string `json:"url,omitempty"`

	// The IP of the cluster API server.
	IP string `json:"ip,omitempty"`
}

APIServerProfile represents an API server profile.

type ClusterProfile 

type ClusterProfile struct {
	// The pull secret for the cluster.
	PullSecret string `json:"pullSecret,omitempty"`

	// The domain for the cluster.
	Domain string `json:"domain,omitempty"`

	// The version of the cluster.
	Version string `json:"version,omitempty"`

	// The ID of the cluster resource group.
	ResourceGroupID string `json:"resourceGroupId,omitempty"`

	// If FIPS validated crypto modules are used
	FipsValidatedModules FipsValidatedModules `json:"fipsValidatedModules,omitempty"`
}

ClusterProfile represents a cluster profile.

type ConsoleProfile 

type ConsoleProfile struct {
	// The URL to access the cluster console.
	URL string `json:"url,omitempty"`
}

ConsoleProfile represents a console profile.

type CreatedByType 

type CreatedByType string

CreatedByType by defines user type, which executed the request 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

type EncryptionAtHost 

type EncryptionAtHost string

EncryptionAtHost represents encryption at host state 

const (
	EncryptionAtHostEnabled  EncryptionAtHost = "Enabled"
	EncryptionAtHostDisabled EncryptionAtHost = "Disabled"
)

EncryptionAtHost constants

type FipsValidatedModules 

type FipsValidatedModules string

FipsValidatedModules determines if FIPS is used. 

const (
	FipsValidatedModulesEnabled  FipsValidatedModules = "Enabled"
	FipsValidatedModulesDisabled FipsValidatedModules = "Disabled"
)

FipsValidatedModules constants.

type IngressProfile 

type IngressProfile struct {
	// The ingress profile name.
	Name string `json:"name,omitempty"`

	// Ingress visibility.
	Visibility Visibility `json:"visibility,omitempty"`

	// The IP of the ingress.
	IP string `json:"ip,omitempty"`
}

IngressProfile represents an ingress profile.

type MasterProfile 

type MasterProfile struct {
	// The size of the master VMs.
	VMSize VMSize `json:"vmSize,omitempty"`

	// The Azure resource ID of the master subnet.
	SubnetID string `json:"subnetId,omitempty"`

	// Whether master virtual machines are encrypted at host.
	EncryptionAtHost EncryptionAtHost `json:"encryptionAtHost,omitempty"`

	// The resource ID of an associated DiskEncryptionSet, if applicable.
	DiskEncryptionSetID string `json:"diskEncryptionSetId,omitempty"`
}

MasterProfile represents a master profile.

type NetworkProfile 

type NetworkProfile struct {
	// The CIDR used for OpenShift/Kubernetes Pods.
	PodCIDR string `json:"podCidr,omitempty"`

	// The CIDR used for OpenShift/Kubernetes Services.
	ServiceCIDR string `json:"serviceCidr,omitempty"`
}

NetworkProfile represents a network profile.

type OpenShiftCluster 

type OpenShiftCluster struct {
	// The resource ID.
	ID string `json:"id,omitempty" mutable:"case"`

	// The resource name.
	Name string `json:"name,omitempty" mutable:"case"`

	// The resource type.
	Type string `json:"type,omitempty" mutable:"case"`

	// The resource location.
	Location string `json:"location,omitempty"`

	// SystemData - The system metadata relating to this resource
	SystemData *SystemData `json:"systemData,omitempty"`

	// The resource tags.
	Tags Tags `json:"tags,omitempty" mutable:"true"`

	// The cluster properties.
	Properties OpenShiftClusterProperties `json:"properties,omitempty"`
}

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

type OpenShiftClusterAdminKubeconfig 

type OpenShiftClusterAdminKubeconfig struct {
	// The base64-encoded kubeconfig file.
	Kubeconfig []byte `json:"kubeconfig,omitempty"`
}

OpenShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig.

type OpenShiftClusterCredentials 

type OpenShiftClusterCredentials struct {
	// The username for the kubeadmin user.
	KubeadminUsername string `json:"kubeadminUsername,omitempty"`

	// The password for the kubeadmin user.
	KubeadminPassword string `json:"kubeadminPassword,omitempty"`
}

OpenShiftClusterCredentials represents an OpenShift cluster's credentials.

type OpenShiftClusterList 

type OpenShiftClusterList struct {
	// The list of OpenShift clusters.
	OpenShiftClusters []*OpenShiftCluster `json:"value"`

	// The link used to get the next page of operations.
	NextLink string `json:"nextLink,omitempty"`
}

OpenShiftClusterList represents a list of OpenShift clusters.

type OpenShiftClusterProperties 

type OpenShiftClusterProperties struct {
	// The cluster provisioning state.
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`

	// The cluster profile.
	ClusterProfile ClusterProfile `json:"clusterProfile,omitempty"`

	// The console profile.
	ConsoleProfile ConsoleProfile `json:"consoleProfile,omitempty"`

	// The cluster service principal profile.
	ServicePrincipalProfile ServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"`

	// The cluster network profile.
	NetworkProfile NetworkProfile `json:"networkProfile,omitempty"`

	// The cluster master profile.
	MasterProfile MasterProfile `json:"masterProfile,omitempty"`

	// The cluster worker profiles.
	WorkerProfiles []WorkerProfile `json:"workerProfiles,omitempty"`

	// The cluster API server profile.
	APIServerProfile APIServerProfile `json:"apiserverProfile,omitempty"`

	// The cluster ingress profiles.
	IngressProfiles []IngressProfile `json:"ingressProfiles,omitempty"`
}

OpenShiftClusterProperties represents an OpenShift cluster's properties.

type ProvisioningState 

type ProvisioningState string

ProvisioningState represents a provisioning state. 

const (
	ProvisioningStateCreating      ProvisioningState = "Creating"
	ProvisioningStateUpdating      ProvisioningState = "Updating"
	ProvisioningStateAdminUpdating ProvisioningState = "AdminUpdating"
	ProvisioningStateDeleting      ProvisioningState = "Deleting"
	ProvisioningStateSucceeded     ProvisioningState = "Succeeded"
	ProvisioningStateFailed        ProvisioningState = "Failed"
)

ProvisioningState constants.

type ServicePrincipalProfile 

type ServicePrincipalProfile struct {
	// The client ID used for the cluster.
	ClientID string `json:"clientId,omitempty" mutable:"true"`

	// The client secret used for the cluster.
	ClientSecret string `json:"clientSecret,omitempty" mutable:"true"`
}

ServicePrincipalProfile represents a service principal profile.

type SystemData 

type SystemData struct {
	// The identity that created the resource.
	CreatedBy string `json:"createdBy,omitempty"`
	// The type of identity that created the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// The identity that last modified the resource.
	LastModifiedBy string `json:"lastModifiedBy,omitempty"`
	// The type of identity that last modified the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// The type of identity that last modified the resource.
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type Tags 

type Tags map[string]string

Tags represents an OpenShift cluster's tags.

func (*Tags) UnmarshalJSON 

func (t *Tags) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals tags. We override this to ensure that PATCH behaviour overwrites an existing tags map rather than endlessly adding to it

type VMSize 

type VMSize string

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc.), pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/en-us/azure/openshift/support-policies-v4#supported-virtual-machine-sizes

type Visibility 

type Visibility string

Visibility represents visibility. 

const (
	VisibilityPublic  Visibility = "Public"
	VisibilityPrivate Visibility = "Private"
)

Visibility constants

type WorkerProfile 

type WorkerProfile struct {
	// The worker profile name.
	Name string `json:"name,omitempty"`

	// The size of the worker VMs.
	VMSize VMSize `json:"vmSize,omitempty"`

	// The disk size of the worker VMs.
	DiskSizeGB int `json:"diskSizeGB,omitempty"`

	// The Azure resource ID of the worker subnet.
	SubnetID string `json:"subnetId,omitempty"`

	// The number of worker VMs.
	Count int `json:"count,omitempty"`

	// Whether master virtual machines are encrypted at host.
	EncryptionAtHost EncryptionAtHost `json:"encryptionAtHost,omitempty"`

	// The resource ID of an associated DiskEncryptionSet, if applicable.
	DiskEncryptionSetID string `json:"diskEncryptionSetId,omitempty"`
}

WorkerProfile represents a worker profile.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.