diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/404.html b/404.html new file mode 100644 index 000000000..88ff58667 --- /dev/null +++ b/404.html @@ -0,0 +1,1558 @@ + + + +
+ + + + + + + + + + + + + + +Packages:
+Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types:
+ConfigMapKeySelector is a reference to a specific ‘key’ within a ConfigMap resource.
+In some instances, key
is a required field.
Field | +Description | +
---|---|
+name + +string + + |
+
+ Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+
+key + +string + + |
+
+(Optional)
+ The key of the entry in the ConfigMap resource’s |
+
+(Appears on:IPRange) +
+IP is an IP address.
+Field | +Description | +
---|---|
+- + + +net/netip.Addr + + + |
++ | +
IPPrefix represents a network prefix.
+Field | +Description | +
---|---|
+- + + +net/netip.Prefix + + + |
++ | +
IPRange is an IP range.
+Field | +Description | +
---|---|
+from + + +IP + + + |
++ | +
+to + + +IP + + + |
++ | +
LocalUIDReference is a reference to another entity including its UID
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the referenced entity. + |
+
+uid + + +k8s.io/apimachinery/pkg/types.UID + + + |
+
+ UID is the UID of the referenced entity. + |
+
SecretKeySelector is a reference to a specific ‘key’ within a Secret resource.
+In some instances, key
is a required field.
Field | +Description | +
---|---|
+name + +string + + |
+
+ Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+
+key + +string + + |
+
+(Optional)
+ The key of the entry in the Secret resource’s |
+
The resource pool this Taint is attached to has the “effect” on +any resource that does not tolerate the Taint.
+Field | +Description | +
---|---|
+key + +string + + |
+
+ The taint key to be applied to a resource pool. + |
+
+value + +string + + |
+
+ The taint value corresponding to the taint key. + |
+
+effect + + +TaintEffect + + + |
+
+ The effect of the taint on resources +that do not tolerate the taint. +Valid effects are NoSchedule, PreferNoSchedule and NoExecute. + |
+
string
alias)+(Appears on:Taint, Toleration) +
+Value | +Description | +
---|---|
"NoSchedule" |
+Do not allow new resources to schedule onto the resource pool unless they tolerate the taint, +but allow all already-running resources to continue running. +Enforced by the scheduler. + |
+
The resource this Toleration is attached to tolerates any taint that matches
+the triple
Field | +Description | +
---|---|
+key + +string + + |
+
+ Key is the taint key that the toleration applies to. Empty means match all taint keys. +If the key is empty, operator must be Exists; this combination means to match all values and all keys. + |
+
+operator + + +TolerationOperator + + + |
+
+ Operator represents a key’s relationship to the value. +Valid operators are Exists and Equal. Defaults to Equal. +Exists is equivalent to wildcard for value, so that a resource can +tolerate all taints of a particular category. + |
+
+value + +string + + |
+
+ Value is the taint value the toleration matches to. +If the operator is Exists, the value should be empty, otherwise just a regular string. + |
+
+effect + + +TaintEffect + + + |
+
+ Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule. + |
+
string
alias)+(Appears on:Toleration) +
+A toleration operator is the set of operators that can be used in a toleration.
+Value | +Description | +
---|---|
"Equal" |
++ |
"Exists" |
++ |
UIDReference is a reference to another entity in a potentially different namespace including its UID.
+Field | +Description | +
---|---|
+namespace + +string + + |
+
+ Namespace is the namespace of the referenced entity. If empty, +the same namespace as the referring resource is implied. + |
+
+name + +string + + |
+
+ Name is the name of the referenced entity. + |
+
+uid + + +k8s.io/apimachinery/pkg/types.UID + + + |
+
+ UID is the UID of the referenced entity. + |
+
+Generated with gen-crd-api-reference-docs
+
Packages:
+ +Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types:
+Machine is the Schema for the machines API
+Field | +Description | +||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+compute.ironcore.dev/v1alpha1
+
+ |
+||||||||||||||||||||||
+kind +string + |
+Machine |
+||||||||||||||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||
+spec + + +MachineSpec + + + |
+
+ + +
|
+||||||||||||||||||||||
+status + + +MachineStatus + + + |
++ | +
MachineClass is the Schema for the machineclasses API
+Field | +Description | +
---|---|
+apiVersion +string |
+
+
+compute.ironcore.dev/v1alpha1
+
+ |
+
+kind +string + |
+MachineClass |
+
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+capabilities + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
++ | +
MachinePool is the Schema for the machinepools API
+Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion +string |
+
+
+compute.ironcore.dev/v1alpha1
+
+ |
+||||
+kind +string + |
+MachinePool |
+||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec + + +MachinePoolSpec + + + |
+
+ + +
|
+||||
+status + + +MachinePoolStatus + + + |
++ | +
+(Appears on:MachinePoolDaemonEndpoints) +
+DaemonEndpoint contains information about a single Daemon endpoint.
+Field | +Description | +
---|---|
+port + +int32 + + |
+
+ Port number of the given endpoint. + |
+
+(Appears on:MachineSpec) +
+EFIVar is a variable to pass to EFI while booting up.
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the EFIVar. + |
+
+uuid + +string + + |
+
+ UUID is the uuid of the EFIVar. + |
+
+value + +string + + |
+
+ Value is the value of the EFIVar. + |
+
+(Appears on:VolumeSource) +
+EmptyDiskVolumeSource is a volume that’s offered by the machine pool provider. +Usually ephemeral (i.e. deleted when the surrounding entity is deleted), with +varying performance characteristics. Potentially not recoverable.
+Field | +Description | +
---|---|
+sizeLimit + + +k8s.io/apimachinery/pkg/api/resource.Quantity + + + |
+
+ SizeLimit is the total amount of local storage required for this EmptyDisk volume. +The default is nil which means that the limit is undefined. + |
+
+(Appears on:NetworkInterfaceSource) +
+EphemeralNetworkInterfaceSource is a definition for an ephemeral (i.e. coupled to the lifetime of the surrounding +object) networking.NetworkInterface.
+Field | +Description | +
---|---|
+networkInterfaceTemplate + + +github.com/ironcore-dev/ironcore/api/networking/v1alpha1.NetworkInterfaceTemplateSpec + + + |
+
+ NetworkInterfaceTemplate is the template definition of the networking.NetworkInterface. + |
+
+(Appears on:VolumeSource) +
+EphemeralVolumeSource is a definition for an ephemeral (i.e. coupled to the lifetime of the surrounding object) +storage.Volume.
+Field | +Description | +
---|---|
+volumeTemplate + + +github.com/ironcore-dev/ironcore/api/storage/v1alpha1.VolumeTemplateSpec + + + |
+
+ VolumeTemplate is the template definition of the storage.Volume. + |
+
MachineExecOptions is the query options to a Machine’s remote exec call
+Field | +Description | +
---|---|
+insecureSkipTLSVerifyBackend + +bool + + |
++ | +
+(Appears on:MachinePoolStatus) +
+Field | +Description | +
---|---|
+type + + +MachinePoolAddressType + + + |
++ | +
+address + +string + + |
++ | +
string
alias)+(Appears on:MachinePoolAddress) +
+Value | +Description | +
---|---|
"ExternalDNS" |
+MachinePoolExternalDNS identifies a DNS name which resolves to an IP address which has the characteristics +of MachinePoolExternalIP. The IP it resolves to may or may not be a listed MachineExternalIP address. + |
+
"ExternalIP" |
+MachinePoolExternalIP identifies an IP address which is, in some way, intended to be more usable from outside +the cluster than an internal IP, though no specific semantics are defined. + |
+
"Hostname" |
+MachinePoolHostName identifies a name of the machine pool. Although every machine pool can be assumed +to have a MachinePoolAddress of this type, its exact syntax and semantics are not +defined, and are not consistent between different clusters. + |
+
"InternalDNS" |
+MachinePoolInternalDNS identifies a DNS name which resolves to an IP address which has +the characteristics of a MachinePoolInternalIP. The IP it resolves to may or may not +be a listed MachinePoolInternalIP address. + |
+
"InternalIP" |
+MachinePoolInternalIP identifies an IP address which may not be visible to hosts outside the cluster. +By default, it is assumed that ironcore-apiserver can reach machine pool internal IPs, though it is possible +to configure clusters where this is not the case. +MachinePoolInternalIP is the default type of machine pool IP, and does not necessarily imply +that the IP is ONLY reachable internally. If a machine pool has multiple internal IPs, +no specific semantics are assigned to the additional IPs. + |
+
+(Appears on:MachinePoolStatus) +
+MachinePoolCondition is one of the conditions of a volume.
+Field | +Description | +
---|---|
+type + + +MachinePoolConditionType + + + |
+
+ Type is the type of the condition. + |
+
+status + + +Kubernetes core/v1.ConditionStatus + + + |
+
+ Status is the status of the condition. + |
+
+reason + +string + + |
+
+ Reason is a machine-readable indication of why the condition is in a certain state. + |
+
+message + +string + + |
+
+ Message is a human-readable explanation of why the condition has a certain reason / state. + |
+
+observedGeneration + +int64 + + |
+
+ ObservedGeneration represents the .metadata.generation that the condition was set based upon. + |
+
+lastTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastTransitionTime is the last time the status of a condition has transitioned from one state to another. + |
+
string
alias)+(Appears on:MachinePoolCondition) +
+MachinePoolConditionType is a type a MachinePoolCondition can have.
++(Appears on:MachinePoolStatus) +
+MachinePoolDaemonEndpoints lists ports opened by daemons running on the MachinePool.
+Field | +Description | +
---|---|
+machinepoolletEndpoint + + +DaemonEndpoint + + + |
+
+(Optional)
+ Endpoint on which machinepoollet is listening. + |
+
+(Appears on:MachinePool) +
+MachinePoolSpec defines the desired state of MachinePool
+Field | +Description | +
---|---|
+providerID + +string + + |
+
+ ProviderID identifies the MachinePool on provider side. + |
+
+taints + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint + + + |
+
+ Taints of the MachinePool. Only Machines who tolerate all the taints +will land in the MachinePool. + |
+
string
alias)+(Appears on:MachinePoolStatus) +
+MachinePoolState is a state a MachinePool can be in.
+Value | +Description | +
---|---|
"Error" |
+MachinePoolStateError marks a MachinePool in an error state. + |
+
"Offline" |
+MachinePoolStateOffline marks a MachinePool as offline. + |
+
"Pending" |
+MachinePoolStatePending marks a MachinePool as pending readiness. + |
+
"Ready" |
+MachinePoolStateReady marks a MachinePool as ready for accepting a Machine. + |
+
+(Appears on:MachinePool) +
+MachinePoolStatus defines the observed state of MachinePool
+Field | +Description | +
---|---|
+state + + +MachinePoolState + + + |
++ | +
+conditions + + +[]MachinePoolCondition + + + |
++ | +
+availableMachineClasses + + +[]Kubernetes core/v1.LocalObjectReference + + + |
++ | +
+addresses + + +[]MachinePoolAddress + + + |
++ | +
+daemonEndpoints + + +MachinePoolDaemonEndpoints + + + |
++ | +
+capacity + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Capacity represents the total resources of a machine pool. + |
+
+allocatable + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Allocatable represents the resources of a machine pool that are available for scheduling. + |
+
+(Appears on:Machine) +
+MachineSpec defines the desired state of Machine
+Field | +Description | +
---|---|
+machineClassRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ MachineClassRef is a reference to the machine class/flavor of the machine. + |
+
+machinePoolSelector + +map[string]string + + |
+
+ MachinePoolSelector selects a suitable MachinePoolRef by the given labels. + |
+
+machinePoolRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ MachinePoolRef defines machine pool to run the machine in. +If empty, a scheduler will figure out an appropriate pool to run the machine in. + |
+
+power + + +Power + + + |
+
+ Power is the desired machine power state. +Defaults to PowerOn. + |
+
+image + +string + + |
+
+(Optional)
+ Image is the optional URL providing the operating system image of the machine. + |
+
+imagePullSecret + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ ImagePullSecretRef is an optional secret for pulling the image of a machine. + |
+
+networkInterfaces + + +[]NetworkInterface + + + |
+
+(Optional)
+ NetworkInterfaces define a list of network interfaces present on the machine + |
+
+volumes + + +[]Volume + + + |
+
+(Optional)
+ Volumes are volumes attached to this machine. + |
+
+ignitionRef + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.SecretKeySelector + + + |
+
+ IgnitionRef is a reference to a secret containing the ignition YAML for the machine to boot up. +If key is empty, DefaultIgnitionKey will be used as fallback. + |
+
+efiVars + + +[]EFIVar + + + |
+
+(Optional)
+ EFIVars are variables to pass to EFI while booting up. + |
+
+tolerations + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration + + + |
+
+ Tolerations define tolerations the Machine has. Only MachinePools whose taints +covered by Tolerations will be considered to run the Machine. + |
+
string
alias)+(Appears on:MachineStatus) +
+MachineState is the state of a machine.
+Value | +Description | +
---|---|
"Pending" |
+MachineStatePending means the Machine has been accepted by the system, but not yet completely started. +This includes time before being bound to a MachinePool, as well as time spent setting up the Machine on that +MachinePool. + |
+
"Running" |
+MachineStateRunning means the machine is running on a MachinePool. + |
+
"Shutdown" |
+MachineStateShutdown means the machine is shut down. + |
+
"Terminated" |
+MachineStateTerminated means the machine has been permanently stopped and cannot be started. + |
+
"Terminating" |
+MachineStateTerminating means the machine that is terminating. + |
+
+(Appears on:Machine) +
+MachineStatus defines the observed state of Machine
+Field | +Description | +
---|---|
+machineID + +string + + |
+
+ MachineID is the provider specific machine ID in the format ‘ |
+
+observedGeneration + +int64 + + |
+
+ ObservedGeneration is the last generation the MachinePool observed of the Machine. + |
+
+state + + +MachineState + + + |
+
+ State is the infrastructure state of the machine. + |
+
+networkInterfaces + + +[]NetworkInterfaceStatus + + + |
+
+ NetworkInterfaces is the list of network interface states for the machine. + |
+
+volumes + + +[]VolumeStatus + + + |
+
+ Volumes is the list of volume states for the machine. + |
+
+(Appears on:MachineSpec) +
+NetworkInterface is the definition of a single interface
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the network interface. + |
+
+NetworkInterfaceSource + + +NetworkInterfaceSource + + + |
+
+
+(Members of NetworkInterfaceSource is where to obtain the interface from. + |
+
+(Appears on:NetworkInterface) +
+Field | +Description | +
---|---|
+networkInterfaceRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ NetworkInterfaceRef instructs to use the NetworkInterface at the target reference. + |
+
+ephemeral + + +EphemeralNetworkInterfaceSource + + + |
+
+ Ephemeral instructs to create an ephemeral (i.e. coupled to the lifetime of the surrounding object) +NetworkInterface to use. + |
+
string
alias)+(Appears on:NetworkInterfaceStatus) +
+NetworkInterfaceState is the infrastructure attachment state a NetworkInterface can be in.
+Value | +Description | +
---|---|
"Attached" |
+NetworkInterfaceStateAttached indicates that a network interface has been successfully attached. + |
+
"Pending" |
+NetworkInterfaceStatePending indicates that the attachment of a network interface is pending. + |
+
+(Appears on:MachineStatus) +
+NetworkInterfaceStatus reports the status of an NetworkInterfaceSource.
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the NetworkInterface to whom the status belongs to. + |
+
+handle + +string + + |
+
+ Handle is the MachinePool internal handle of the NetworkInterface. + |
+
+state + + +NetworkInterfaceState + + + |
+
+ State represents the attachment state of a NetworkInterface. + |
+
+networkInterfaceRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ networkInterfaceRef is the reference to the networkinterface attached to the machine + |
+
+lastStateTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastStateTransitionTime is the last time the State transitioned. + |
+
string
alias)+(Appears on:MachineSpec) +
+Power is the desired power state of a Machine.
+Value | +Description | +
---|---|
"Off" |
+PowerOff indicates that a Machine should be powered off. + |
+
"On" |
+PowerOn indicates that a Machine should be powered on. + |
+
+(Appears on:MachineSpec) +
+Volume defines a volume attachment of a machine
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the Volume + |
+
+device + +string + + |
+
+ Device is the device name where the volume should be attached. +Pointer to distinguish between explicit zero and not specified. +If empty, an unused device name will be determined if possible. + |
+
+VolumeSource + + +VolumeSource + + + |
+
+
+(Members of VolumeSource is the source where the storage for the Volume resides at. + |
+
+(Appears on:Volume) +
+VolumeSource specifies the source to use for a Volume.
+Field | +Description | +
---|---|
+volumeRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ VolumeRef instructs to use the specified Volume as source for the attachment. + |
+
+emptyDisk + + +EmptyDiskVolumeSource + + + |
+
+ EmptyDisk instructs to use a Volume offered by the machine pool provider. + |
+
+ephemeral + + +EphemeralVolumeSource + + + |
+
+ Ephemeral instructs to create an ephemeral (i.e. coupled to the lifetime of the surrounding object) +Volume to use. + |
+
string
alias)+(Appears on:VolumeStatus) +
+VolumeState is the infrastructure attachment state a Volume can be in.
+Value | +Description | +
---|---|
"Attached" |
+VolumeStateAttached indicates that a volume has been successfully attached. + |
+
"Pending" |
+VolumeStatePending indicates that the attachment of a volume is pending. + |
+
+(Appears on:MachineStatus) +
+VolumeStatus is the status of a Volume.
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of a volume attachment. + |
+
+handle + +string + + |
+
+ Handle is the MachinePool internal handle of the volume. + |
+
+state + + +VolumeState + + + |
+
+ State represents the attachment state of a Volume. + |
+
+lastStateTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastStateTransitionTime is the last time the State transitioned. + |
+
+volumeRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ VolumeRef reference to the claimed Volume + |
+
+Generated with gen-crd-api-reference-docs
+
Packages:
+Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types:
+ +ResourceQuota is the Schema for the resourcequotas API
+Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion +string |
+
+
+core.ironcore.dev/v1alpha1
+
+ |
+||||
+kind +string + |
+ResourceQuota |
+||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec + + +ResourceQuotaSpec + + + |
+
+ + +
|
+||||
+status + + +ResourceQuotaStatus + + + |
++ | +
string
alias)Value | +Description | +
---|---|
"machine" |
++ |
"volume" |
++ |
ObjectSelector specifies how to select objects of a certain kind.
+Field | +Description | +
---|---|
+kind + +string + + |
+
+ Kind is the kind of object to select. + |
+
+LabelSelector + + +Kubernetes meta/v1.LabelSelector + + + |
+
+
+(Members of LabelSelector is the label selector to select objects of the specified Kind by. + |
+
string
alias)ResourceName is the name of a resource, most often used alongside a resource.Quantity.
+Value | +Description | +
---|---|
"cpu" |
+ResourceCPU is the amount of cpu in cores. + |
+
"iops" |
+ResourceIOPS defines max IOPS in input/output operations per second. + |
+
"memory" |
+ResourceMemory is the amount of memory in bytes. + |
+
"requests.cpu" |
+ResourceRequestsCPU is the amount of requested cpu in cores. + |
+
"requests.memory" |
+ResourceRequestsMemory is the amount of requested memory in bytes. + |
+
"requests.storage" |
+ResourceRequestsStorage is the amount of requested storage in bytes. + |
+
"storage" |
+ResourceStorage is the amount of storage, in bytes. + |
+
"tps" |
+ResourceTPS defines max throughput per second. (e.g. 1Gi) + |
+
+(Appears on:ResourceQuota) +
+ResourceQuotaSpec defines the desired state of ResourceQuotaSpec
+Field | +Description | +
---|---|
+hard + + +ResourceList + + + |
+
+ Hard is a ResourceList of the strictly enforced amount of resources. + |
+
+scopeSelector + + +ResourceScopeSelector + + + |
+
+ ScopeSelector selects the resources that are subject to this quota. +Note: By using certain ScopeSelectors, only certain resources may be tracked. + |
+
+(Appears on:ResourceQuota) +
+ResourceQuotaStatus is the status of a ResourceQuota.
+Field | +Description | +
---|---|
+hard + + +ResourceList + + + |
+
+ Hard are the currently enforced hard resource limits. Hard may be less than used in +case the limits were introduced / updated after more than allowed resources were already present. + |
+
+used + + +ResourceList + + + |
+
+ Used is the amount of currently used resources. + |
+
string
alias)+(Appears on:ResourceScopeSelectorRequirement) +
+ResourceScope is a scope of a resource.
+Value | +Description | +
---|---|
"BucketClass" |
+ResourceScopeBucketClass refers to the bucket class of a resource. + |
+
"MachineClass" |
+ResourceScopeMachineClass refers to the machine class of a resource. + |
+
"VolumeClass" |
+ResourceScopeVolumeClass refers to the volume class of a resource. + |
+
+(Appears on:ResourceQuotaSpec) +
+ResourceScopeSelector selects
+Field | +Description | +
---|---|
+matchExpressions + + +[]ResourceScopeSelectorRequirement + + + |
+
+ MatchExpressions is a list of ResourceScopeSelectorRequirement to match resources by. + |
+
string
alias)+(Appears on:ResourceScopeSelectorRequirement) +
+ResourceScopeSelectorOperator is an operator to compare a ResourceScope with values.
+Value | +Description | +
---|---|
"DoesNotExist" |
++ |
"Exists" |
++ |
"In" |
++ |
"NotIn" |
++ |
+(Appears on:ResourceScopeSelector) +
+ResourceScopeSelectorRequirement is a requirement for a resource using a ResourceScope alongside +a ResourceScopeSelectorOperator with Values (depending on the ResourceScopeSelectorOperator).
+Field | +Description | +
---|---|
+scopeName + + +ResourceScope + + + |
+
+ ScopeName is the ResourceScope to make a requirement for. + |
+
+operator + + +ResourceScopeSelectorOperator + + + |
+
+ Operator is the ResourceScopeSelectorOperator to check the ScopeName with in a resource. + |
+
+values + +[]string + + |
+
+ Values are the values to compare the Operator with the ScopeName. May be optional. + |
+
+Generated with gen-crd-api-reference-docs
+
Packages:
+Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types:
+Prefix is the Schema for the prefixes API
+Field | +Description | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+ipam.ironcore.dev/v1alpha1
+
+ |
+||||||||||
+kind +string + |
+Prefix |
+||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec + + +PrefixSpec + + + |
+
+ + +
|
+||||||||||
+status + + +PrefixStatus + + + |
++ | +
PrefixAllocation is the Schema for the prefixallocations API
+Field | +Description | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+ipam.ironcore.dev/v1alpha1
+
+ |
+||||||||||
+kind +string + |
+PrefixAllocation |
+||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec + + +PrefixAllocationSpec + + + |
+
+ + +
|
+||||||||||
+status + + +PrefixAllocationStatus + + + |
++ | +
string
alias)+(Appears on:PrefixAllocationStatus) +
+PrefixAllocationPhase is a phase a PrefixAllocation can be in.
+Value | +Description | +
---|---|
"Allocated" |
+PrefixAllocationPhaseAllocated marks a PrefixAllocation as allocated by a Prefix. + |
+
"Failed" |
+PrefixAllocationPhaseFailed marks a PrefixAllocation as failed. + |
+
"Pending" |
+PrefixAllocationPhasePending marks a PrefixAllocation as waiting for allocation. + |
+
+(Appears on:PrefixAllocation) +
+PrefixAllocationSpec defines the desired state of PrefixAllocation
+Field | +Description | +
---|---|
+ipFamily + + +Kubernetes core/v1.IPFamily + + + |
+
+ IPFamily is the IPFamily of the prefix. +If unset but Prefix is set, this can be inferred. + |
+
+prefix + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Prefix is the prefix to allocate for this Prefix. + |
+
+prefixLength + +int32 + + |
+
+ PrefixLength is the length of prefix to allocate for this Prefix. + |
+
+prefixRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ PrefixRef references the prefix to allocate from. + |
+
+prefixSelector + + +Kubernetes meta/v1.LabelSelector + + + |
+
+ PrefixSelector selects the prefix to allocate from. + |
+
+(Appears on:PrefixAllocation) +
+PrefixAllocationStatus is the status of a PrefixAllocation.
+Field | +Description | +
---|---|
+prefix + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Prefix is the allocated prefix, if any + |
+
+phase + + +PrefixAllocationPhase + + + |
+
+ Phase is the phase of the PrefixAllocation. + |
+
+lastPhaseTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastPhaseTransitionTime is the last time the Phase changed values. + |
+
string
alias)+(Appears on:PrefixStatus) +
+PrefixPhase is a phase a Prefix can be in.
+Value | +Description | +
---|---|
"Allocated" |
+PrefixPhaseAllocated marks a prefix as allocated. + |
+
"Pending" |
+PrefixPhasePending marks a prefix as waiting for allocation. + |
+
+(Appears on:Prefix, PrefixTemplateSpec) +
+PrefixSpec defines the desired state of Prefix
+Field | +Description | +
---|---|
+ipFamily + + +Kubernetes core/v1.IPFamily + + + |
+
+ IPFamily is the IPFamily of the prefix. +If unset but Prefix is set, this can be inferred. + |
+
+prefix + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Prefix is the prefix to allocate for this Prefix. + |
+
+prefixLength + +int32 + + |
+
+ PrefixLength is the length of prefix to allocate for this Prefix. + |
+
+parentRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ ParentRef references the parent to allocate the Prefix from. +If ParentRef and ParentSelector is empty, the Prefix is considered a root prefix and thus +allocated by itself. + |
+
+parentSelector + + +Kubernetes meta/v1.LabelSelector + + + |
+
+ ParentSelector is the LabelSelector to use for determining the parent for this Prefix. + |
+
+(Appears on:Prefix) +
+PrefixStatus defines the observed state of Prefix
+Field | +Description | +
---|---|
+phase + + +PrefixPhase + + + |
+
+ Phase is the PrefixPhase of the Prefix. + |
+
+lastPhaseTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastPhaseTransitionTime is the last time the Phase changed values. + |
+
+used + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Used is a list of used prefixes. + |
+
Field | +Description | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec + + +PrefixSpec + + + |
+
+ + +
|
+
+Generated with gen-crd-api-reference-docs
+
Packages:
+ +Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types:
+LoadBalancer is the Schema for the LoadBalancer API
+Field | +Description | +||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+||||||||||||
+kind +string + |
+LoadBalancer |
+||||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||
+spec + + +LoadBalancerSpec + + + |
+
+ + +
|
+||||||||||||
+status + + +LoadBalancerStatus + + + |
++ | +
LoadBalancerRouting is the Schema for the loadbalancerroutings API
+Field | +Description | +
---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+
+kind +string + |
+LoadBalancerRouting |
+
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+networkRef + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference + + + |
+
+ NetworkRef is the network the load balancer is assigned to. + |
+
+destinations + + +[]LoadBalancerDestination + + + |
+
+ Destinations are the destinations for an LoadBalancer. + |
+
NATGateway is the Schema for the NATGateway API
+Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+||||||||
+kind +string + |
+NATGateway |
+||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec + + +NATGatewaySpec + + + |
+
+ + +
|
+||||||||
+status + + +NATGatewayStatus + + + |
++ | +
Network is the Schema for the network API
+Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+||||||
+kind +string + |
+Network |
+||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec + + +NetworkSpec + + + |
+
+ + +
|
+||||||
+status + + +NetworkStatus + + + |
++ | +
NetworkInterface is the Schema for the networkinterfaces API
+Field | +Description | +||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+||||||||||||||||
+kind +string + |
+NetworkInterface |
+||||||||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||
+spec + + +NetworkInterfaceSpec + + + |
+
+ + +
|
+||||||||||||||||
+status + + +NetworkInterfaceStatus + + + |
++ | +
NetworkPolicy is the Schema for the networkpolicies API
+Field | +Description | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+||||||||||
+kind +string + |
+NetworkPolicy |
+||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec + + +NetworkPolicySpec + + + |
+
+ + +
|
+||||||||||
+status + + +NetworkPolicyStatus + + + |
++ | +
VirtualIP is the Schema for the virtualips API
+Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+networking.ironcore.dev/v1alpha1
+
+ |
+||||||
+kind +string + |
+VirtualIP |
+||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec + + +VirtualIPSpec + + + |
+
+ + +
|
+||||||
+status + + +VirtualIPStatus + + + |
++ | +
+(Appears on:IPSource, PrefixSource) +
+EphemeralPrefixSource contains the definition to create an ephemeral (i.e. coupled to the lifetime of the +surrounding object) Prefix.
+Field | +Description | +
---|---|
+prefixTemplate + + +github.com/ironcore-dev/ironcore/api/ipam/v1alpha1.PrefixTemplateSpec + + + |
+
+ PrefixTemplate is the template for the Prefix. + |
+
+(Appears on:VirtualIPSource) +
+EphemeralVirtualIPSource contains the definition to create an ephemeral (i.e. coupled to the lifetime of the +surrounding object) VirtualIP.
+Field | +Description | +
---|---|
+virtualIPTemplate + + +VirtualIPTemplateSpec + + + |
+
+ VirtualIPTemplate is the template for the VirtualIP. + |
+
+(Appears on:NetworkPolicyPeer) +
+IPBlock specifies an ip block with optional exceptions.
+Field | +Description | +
---|---|
+cidr + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ CIDR is a string representing the ip block. + |
+
+except + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Except is a slice of CIDRs that should not be included within the specified CIDR. +Values will be rejected if they are outside CIDR. + |
+
+(Appears on:LoadBalancerSpec, NetworkInterfaceSpec) +
+IPSource is the definition of how to obtain an IP.
+Field | +Description | +
---|---|
+value + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ Value specifies an IP by using an IP literal. + |
+
+ephemeral + + +EphemeralPrefixSource + + + |
+
+ Ephemeral specifies an IP by creating an ephemeral Prefix to allocate the IP with. + |
+
+(Appears on:LoadBalancerRouting) +
+LoadBalancerDestination is the destination of the load balancer.
+Field | +Description | +
---|---|
+ip + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ IP is the target IP. + |
+
+targetRef + + +LoadBalancerTargetRef + + + |
+
+ TargetRef is the target providing the destination. + |
+
+(Appears on:LoadBalancerSpec) +
+Field | +Description | +
---|---|
+protocol + + +Kubernetes core/v1.Protocol + + + |
+
+ Protocol is the protocol the load balancer should allow. +If not specified, defaults to TCP. + |
+
+port + +int32 + + |
+
+ Port is the port to allow. + |
+
+endPort + +int32 + + |
+
+ EndPort marks the end of the port range to allow. +If unspecified, only a single port, Port, will be allowed. + |
+
+(Appears on:LoadBalancer) +
+LoadBalancerSpec defines the desired state of LoadBalancer
+Field | +Description | +
---|---|
+type + + +LoadBalancerType + + + |
+
+ Type is the type of LoadBalancer. + |
+
+ipFamilies + + +[]Kubernetes core/v1.IPFamily + + + |
+
+ IPFamilies are the ip families the load balancer should have. + |
+
+ips + + +[]IPSource + + + |
+
+ IPs are the ips to use. Can only be used when Type is LoadBalancerTypeInternal. + |
+
+networkRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ NetworkRef is the Network this LoadBalancer should belong to. + |
+
+networkInterfaceSelector + + +Kubernetes meta/v1.LabelSelector + + + |
+
+ NetworkInterfaceSelector defines the NetworkInterfaces +for which this LoadBalancer should be applied + |
+
+ports + + +[]LoadBalancerPort + + + |
+
+ Ports are the ports the load balancer should allow. + |
+
+(Appears on:LoadBalancer) +
+LoadBalancerStatus defines the observed state of LoadBalancer
+Field | +Description | +
---|---|
+ips + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ IPs are the IPs allocated for the load balancer. + |
+
+(Appears on:LoadBalancerDestination) +
+LoadBalancerTargetRef is a load balancer target.
+Field | +Description | +
---|---|
+uid + + +k8s.io/apimachinery/pkg/types.UID + + + |
+
+ UID is the UID of the target. + |
+
+name + +string + + |
+
+ Name is the name of the target. + |
+
+providerID + +string + + |
+
+ ProviderID is the provider internal id of the target. + |
+
string
alias)+(Appears on:LoadBalancerSpec) +
+LoadBalancerType is a type of LoadBalancer.
+Value | +Description | +
---|---|
"Internal" |
+LoadBalancerTypeInternal is a LoadBalancer that allocates and routes network-internal, stable IPs. + |
+
"Public" |
+LoadBalancerTypePublic is a LoadBalancer that allocates and routes a stable public IP. + |
+
+(Appears on:NATGateway) +
+NATGatewaySpec defines the desired state of NATGateway
+Field | +Description | +
---|---|
+type + + +NATGatewayType + + + |
+
+ Type is the type of NATGateway. + |
+
+ipFamily + + +Kubernetes core/v1.IPFamily + + + |
+
+ IPFamily is the ip family the NAT gateway should have. + |
+
+networkRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ NetworkRef is the Network this NATGateway should belong to. + |
+
+portsPerNetworkInterface + +int32 + + |
+
+ PortsPerNetworkInterface defines the number of concurrent connections per target network interface. +Has to be a power of 2. If empty, 2048 (DefaultPortsPerNetworkInterface) is the default. + |
+
+(Appears on:NATGateway) +
+NATGatewayStatus defines the observed state of NATGateway
+Field | +Description | +
---|---|
+ips + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ IPs are the IPs allocated for the NAT gateway. + |
+
string
alias)+(Appears on:NATGatewaySpec) +
+NATGatewayType is a type of NATGateway.
+Value | +Description | +
---|---|
"Public" |
+NATGatewayTypePublic is a NATGateway that allocates and routes a stable public IP. + |
+
+(Appears on:NetworkInterface, NetworkInterfaceTemplateSpec) +
+NetworkInterfaceSpec defines the desired state of NetworkInterface
+Field | +Description | +
---|---|
+providerID + +string + + |
+
+ ProviderID is the provider-internal ID of the network interface. + |
+
+networkRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ NetworkRef is the Network this NetworkInterface is connected to + |
+
+machineRef + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference + + + |
+
+ MachineRef is the Machine this NetworkInterface is used by + |
+
+ipFamilies + + +[]Kubernetes core/v1.IPFamily + + + |
+
+ IPFamilies defines which IPFamilies this NetworkInterface is supporting + |
+
+ips + + +[]IPSource + + + |
+
+ IPs is the list of provided IPs or ephemeral IPs which should be assigned to +this NetworkInterface. + |
+
+prefixes + + +[]PrefixSource + + + |
+
+ Prefixes is the list of provided prefixes or ephemeral prefixes which should be assigned to +this NetworkInterface. + |
+
+virtualIP + + +VirtualIPSource + + + |
+
+ VirtualIP specifies the virtual ip that should be assigned to this NetworkInterface. + |
+
+attributes + +map[string]string + + |
+
+ Attributes are provider-specific attributes for the network interface. + |
+
string
alias)+(Appears on:NetworkInterfaceStatus) +
+NetworkInterfaceState is the ironcore state of a NetworkInterface.
+Value | +Description | +
---|---|
"Available" |
+NetworkInterfaceStateAvailable is used for any NetworkInterface where all properties are valid. + |
+
"Error" |
+NetworkInterfaceStateError is used for any NetworkInterface where any property has an error. + |
+
"Pending" |
+NetworkInterfaceStatePending is used for any NetworkInterface that is pending. + |
+
+(Appears on:NetworkInterface) +
+NetworkInterfaceStatus defines the observed state of NetworkInterface
+Field | +Description | +
---|---|
+state + + +NetworkInterfaceState + + + |
+
+ State is the NetworkInterfaceState of the NetworkInterface. + |
+
+lastStateTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastStateTransitionTime is the last time the State transitioned from one value to another. + |
+
+ips + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ IPs represent the effective IP addresses of the NetworkInterface. + |
+
+prefixes + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Prefixes represent the prefixes routed to the NetworkInterface. + |
+
+virtualIP + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ VirtualIP is any virtual ip assigned to the NetworkInterface. + |
+
NetworkInterfaceTemplateSpec is the specification of a NetworkInterface template.
+Field | +Description | +||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||
+spec + + +NetworkInterfaceSpec + + + |
+
+ + +
|
+
+(Appears on:NetworkSpec) +
+NetworkPeering defines a network peering with another network.
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the semantical name of the network peering. + |
+
+networkRef + + +NetworkPeeringNetworkRef + + + |
+
+ NetworkRef is the reference to the network to peer with. +An empty namespace indicates that the target network resides in the same namespace as the source network. + |
+
+prefixes + + +[]PeeringPrefix + + + |
+
+ Prefixes is a list of prefixes that we want only to be exposed +to the peered network, if no prefixes are specified no filtering will be done. + |
+
+(Appears on:NetworkSpec) +
+Field | +Description | +
---|---|
+namespace + +string + + |
+
+ Namespace is the namespace of the referenced entity. If empty, +the same namespace as the referring resource is implied. + |
+
+name + +string + + |
+
+ Name is the name of the referenced entity. + |
+
+uid + + +k8s.io/apimachinery/pkg/types.UID + + + |
+
+ UID is the UID of the referenced entity. + |
+
+(Appears on:NetworkPeering) +
+NetworkPeeringNetworkRef is a reference to a network to peer with.
+Field | +Description | +
---|---|
+namespace + +string + + |
+
+ Namespace is the namespace of the referenced entity. If empty, +the same namespace as the referring resource is implied. + |
+
+name + +string + + |
+
+ Name is the name of the referenced entity. + |
+
string
alias)+(Appears on:NetworkPeeringStatus) +
+NetworkPeeringState is the state a NetworkPeering can be in
+Value | +Description | +
---|---|
"Error" |
+NetworkPeeringStateError signals that the network peering is in error state. + |
+
"Pending" |
+NetworkPeeringStatePending signals that the network peering is not applied. + |
+
"Ready" |
+NetworkPeeringStateReady signals that the network peering is ready. + |
+
+(Appears on:NetworkStatus) +
+NetworkPeeringStatus is the status of a network peering.
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the network peering. + |
+
+state + + +NetworkPeeringState + + + |
+
+ State represents the network peering state + |
+
+prefixes + + +[]PeeringPrefixStatus + + + |
+
+ Prefixes contains the prefixes exposed to the peered network + |
+
+(Appears on:NetworkPolicyStatus) +
+NetworkPolicyCondition is one of the conditions of a network policy.
+Field | +Description | +
---|---|
+type + + +NetworkPolicyConditionType + + + |
+
+ Type is the type of the condition. + |
+
+status + + +Kubernetes core/v1.ConditionStatus + + + |
+
+ Status is the status of the condition. + |
+
+reason + +string + + |
+
+ Reason is a machine-readable indication of why the condition is in a certain state. + |
+
+message + +string + + |
+
+ Message is a human-readable explanation of why the condition has a certain reason / state. + |
+
+observedGeneration + +int64 + + |
+
+ ObservedGeneration represents the .metadata.generation that the condition was set based upon. + |
+
+lastTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastTransitionTime is the last time the status of a condition has transitioned from one state to another. + |
+
string
alias)+(Appears on:NetworkPolicyCondition) +
+NetworkPolicyConditionType is a type a NetworkPolicyCondition can have.
++(Appears on:NetworkPolicySpec) +
+NetworkPolicyEgressRule describes a rule to regulate egress traffic with.
+Field | +Description | +
---|---|
+ports + + +[]NetworkPolicyPort + + + |
+
+ Ports specifies the list of destination ports that can be called with +this rule. Each item in this list is combined using a logical OR. Empty matches all ports. +As soon as a single item is present, only these ports are allowed. + |
+
+to + + +[]NetworkPolicyPeer + + + |
+
+ To specifies the list of destinations which the selected network interfaces should be +able to send traffic to. Fields are combined using a logical OR. Empty matches all destinations. +As soon as a single item is present, only these peers are allowed. + |
+
+(Appears on:NetworkPolicySpec) +
+NetworkPolicyIngressRule describes a rule to regulate ingress traffic with.
+Field | +Description | +
---|---|
+ports + + +[]NetworkPolicyPort + + + |
+
+ Ports specifies the list of ports which should be made accessible for +this rule. Each item in this list is combined using a logical OR. Empty matches all ports. +As soon as a single item is present, only these ports are allowed. + |
+
+from + + +[]NetworkPolicyPeer + + + |
+
+ From specifies the list of sources which should be able to send traffic to the +selected network interfaces. Fields are combined using a logical OR. Empty matches all sources. +As soon as a single item is present, only these peers are allowed. + |
+
+(Appears on:NetworkPolicyEgressRule, NetworkPolicyIngressRule) +
+NetworkPolicyPeer describes a peer to allow traffic to / from.
+Field | +Description | +
---|---|
+objectSelector + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ObjectSelector + + + |
+
+ ObjectSelector selects peers with the given kind matching the label selector. +Exclusive with other peer specifiers. + |
+
+ipBlock + + +IPBlock + + + |
+
+ IPBlock specifies the ip block from or to which network traffic may come. + |
+
+(Appears on:NetworkPolicyEgressRule, NetworkPolicyIngressRule) +
+NetworkPolicyPort describes a port to allow traffic on
+Field | +Description | +
---|---|
+protocol + + +Kubernetes core/v1.Protocol + + + |
+
+ Protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this +field defaults to TCP. + |
+
+port + +int32 + + |
+
+ The port on the given protocol. If this field is not provided, this matches +all port names and numbers. +If present, only traffic on the specified protocol AND port will be matched. + |
+
+endPort + +int32 + + |
+
+ EndPort indicates that the range of ports from Port to EndPort, inclusive, +should be allowed by the policy. This field cannot be defined if the port field +is not defined. The endPort must be equal or greater than port. + |
+
+(Appears on:NetworkPolicy) +
+NetworkPolicySpec defines the desired state of NetworkPolicy.
+Field | +Description | +
---|---|
+networkRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ NetworkRef is the network to regulate using this policy. + |
+
+networkInterfaceSelector + + +Kubernetes meta/v1.LabelSelector + + + |
+
+ NetworkInterfaceSelector selects the network interfaces that are subject to this policy. + |
+
+ingress + + +[]NetworkPolicyIngressRule + + + |
+
+ Ingress specifies rules for ingress traffic. + |
+
+egress + + +[]NetworkPolicyEgressRule + + + |
+
+ Egress specifies rules for egress traffic. + |
+
+policyTypes + + +[]PolicyType + + + |
+
+ PolicyTypes specifies the types of policies this network policy contains. + |
+
+(Appears on:NetworkPolicy) +
+NetworkPolicyStatus defines the observed state of NetworkPolicy.
+Field | +Description | +
---|---|
+conditions + + +[]NetworkPolicyCondition + + + |
+
+ Conditions are various conditions of the NetworkPolicy. + |
+
+(Appears on:Network) +
+NetworkSpec defines the desired state of Network
+Field | +Description | +
---|---|
+providerID + +string + + |
+
+ ProviderID is the provider-internal ID of the network. + |
+
+peerings + + +[]NetworkPeering + + + |
+
+(Optional)
+ Peerings are the network peerings with this network. + |
+
+incomingPeerings + + +[]NetworkPeeringClaimRef + + + |
+
+(Optional)
+ PeeringClaimRefs are the peering claim references of other networks. + |
+
string
alias)+(Appears on:NetworkStatus) +
+NetworkState is the state of a network.
+Value | +Description | +
---|---|
"Available" |
+NetworkStateAvailable means the network is ready to use. + |
+
"Error" |
+NetworkStateError means the network is in an error state. + |
+
"Pending" |
+NetworkStatePending means the network is being provisioned. + |
+
+(Appears on:Network) +
+NetworkStatus defines the observed state of Network
+Field | +Description | +
---|---|
+state + + +NetworkState + + + |
+
+ State is the state of the machine. + |
+
+peerings + + +[]NetworkPeeringStatus + + + |
+
+(Optional)
+ Peerings contains the states of the network peerings for the network. + |
+
+(Appears on:NetworkPeering) +
+PeeringPrefixes defines prefixes to be exposed to the peered network
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the semantical name of the peering prefixes + |
+
+prefix + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ CIDR to be exposed to the peered network + |
+
+prefixRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ PrefixRef is the reference to the prefix to be exposed to peered network +An empty namespace indicates that the prefix resides in the same namespace as the source network. + |
+
+(Appears on:NetworkPeeringStatus) +
+PeeringPrefixStatus lists prefixes exposed to peered network
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the peering prefix + |
+
+prefix + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ CIDR exposed to the peered network + |
+
string
alias)+(Appears on:NetworkPolicySpec) +
+PolicyType is a type of policy.
+Value | +Description | +
---|---|
"Egress" |
+PolicyTypeEgress is a policy that describes egress traffic. + |
+
"Ingress" |
+PolicyTypeIngress is a policy that describes ingress traffic. + |
+
+(Appears on:NetworkInterfaceSpec) +
+Field | +Description | +
---|---|
+value + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix + + + |
+
+ Value specifies a static prefix to use. + |
+
+ephemeral + + +EphemeralPrefixSource + + + |
+
+ Ephemeral specifies a prefix by creating an ephemeral ipam.Prefix to allocate the prefix with. + |
+
+(Appears on:NetworkInterfaceSpec) +
+VirtualIPSource is the definition of how to obtain a VirtualIP.
+Field | +Description | +
---|---|
+virtualIPRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ VirtualIPRef references a VirtualIP to use. + |
+
+ephemeral + + +EphemeralVirtualIPSource + + + |
+
+ Ephemeral instructs to create an ephemeral (i.e. coupled to the lifetime of the surrounding object) +VirtualIP. + |
+
+(Appears on:VirtualIP, VirtualIPTemplateSpec) +
+VirtualIPSpec defines the desired state of VirtualIP
+Field | +Description | +
---|---|
+type + + +VirtualIPType + + + |
+
+ Type is the type of VirtualIP. + |
+
+ipFamily + + +Kubernetes core/v1.IPFamily + + + |
+
+ IPFamily is the ip family of the VirtualIP. + |
+
+targetRef + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference + + + |
+
+ TargetRef references the target for this VirtualIP (currently only NetworkInterface). + |
+
+(Appears on:VirtualIP) +
+VirtualIPStatus defines the observed state of VirtualIP
+Field | +Description | +
---|---|
+ip + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.IP + + + |
+
+ IP is the allocated IP, if any. + |
+
+(Appears on:EphemeralVirtualIPSource) +
+VirtualIPTemplateSpec is the specification of a VirtualIP template.
+Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec + + +VirtualIPSpec + + + |
+
+ + +
|
+
string
alias)+(Appears on:VirtualIPSpec) +
+VirtualIPType is a type of VirtualIP.
+Value | +Description | +
---|---|
"Public" |
+VirtualIPTypePublic is a VirtualIP that allocates and routes a stable public IP. + |
+
+Generated with gen-crd-api-reference-docs
+
This is the home of the API reference documentation grouped by the various API groups. The content in each subgroup is
+automatically generated from the Go types in the apis
folder. For more information on how the documentation is built
+and how it can be updated please refer to
+the Updating API Reference Documentation
+in the documentation development guide.
Packages:
+ +Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types:
+Bucket is the Schema for the buckets API
+Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+storage.ironcore.dev/v1alpha1
+
+ |
+||||||||
+kind +string + |
+Bucket |
+||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec + + +BucketSpec + + + |
+
+ + +
|
+||||||||
+status + + +BucketStatus + + + |
++ | +
BucketClass is the Schema for the bucketclasses API
+Field | +Description | +
---|---|
+apiVersion +string |
+
+
+storage.ironcore.dev/v1alpha1
+
+ |
+
+kind +string + |
+BucketClass |
+
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+capabilities + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Capabilities describes the capabilities of a BucketClass. + |
+
BucketPool is the Schema for the bucketpools API
+Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion +string |
+
+
+storage.ironcore.dev/v1alpha1
+
+ |
+||||
+kind +string + |
+BucketPool |
+||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec + + +BucketPoolSpec + + + |
+
+ + +
|
+||||
+status + + +BucketPoolStatus + + + |
++ | +
Volume is the Schema for the volumes API
+Field | +Description | +||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion +string |
+
+
+storage.ironcore.dev/v1alpha1
+
+ |
+||||||||||||||||||||
+kind +string + |
+Volume |
+||||||||||||||||||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||
+spec + + +VolumeSpec + + + |
+
+ + +
|
+||||||||||||||||||||
+status + + +VolumeStatus + + + |
++ | +
VolumeClass is the Schema for the volumeclasses API
+Field | +Description | +
---|---|
+apiVersion +string |
+
+
+storage.ironcore.dev/v1alpha1
+
+ |
+
+kind +string + |
+VolumeClass |
+
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+capabilities + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Capabilities describes the capabilities of a VolumeClass. + |
+
+resizePolicy + + +ResizePolicy + + + |
+
+ ResizePolicy describes the supported expansion policy of a VolumeClass. +If not set default to Static expansion policy. + |
+
VolumePool is the Schema for the volumepools API
+Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion +string |
+
+
+storage.ironcore.dev/v1alpha1
+
+ |
+||||
+kind +string + |
+VolumePool |
+||||
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec + + +VolumePoolSpec + + + |
+
+ + +
|
+||||
+status + + +VolumePoolStatus + + + |
++ | +
+(Appears on:BucketStatus) +
+BucketAccess represents information on how to access a bucket.
+Field | +Description | +
---|---|
+secretRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ SecretRef references the Secret containing the access credentials to consume a Bucket. + |
+
+endpoint + +string + + |
+
+ Endpoint defines address of the Bucket REST-API. + |
+
+(Appears on:BucketStatus) +
+BucketCondition is one of the conditions of a bucket.
+Field | +Description | +
---|---|
+type + + +BucketConditionType + + + |
+
+ Type is the type of the condition. + |
+
+status + + +Kubernetes core/v1.ConditionStatus + + + |
+
+ Status is the status of the condition. + |
+
+reason + +string + + |
+
+ Reason is a machine-readable indication of why the condition is in a certain state. + |
+
+message + +string + + |
+
+ Message is a human-readable explanation of why the condition has a certain reason / state. + |
+
+observedGeneration + +int64 + + |
+
+ ObservedGeneration represents the .metadata.generation that the condition was set based upon. + |
+
+lastTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastTransitionTime is the last time the status of a condition has transitioned from one state to another. + |
+
string
alias)+(Appears on:BucketCondition) +
+BucketConditionType is a type a BucketCondition can have.
++(Appears on:BucketPool) +
+BucketPoolSpec defines the desired state of BucketPool
+Field | +Description | +
---|---|
+providerID + +string + + |
+
+ ProviderID identifies the BucketPool on provider side. + |
+
+taints + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint + + + |
+
+ Taints of the BucketPool. Only Buckets who tolerate all the taints +will land in the BucketPool. + |
+
string
alias)+(Appears on:BucketPoolStatus) +
+Value | +Description | +
---|---|
"Available" |
++ |
"Pending" |
++ |
"Unavailable" |
++ |
+(Appears on:BucketPool) +
+BucketPoolStatus defines the observed state of BucketPool
+Field | +Description | +
---|---|
+state + + +BucketPoolState + + + |
+
+ State represents the infrastructure state of a BucketPool. + |
+
+availableBucketClasses + + +[]Kubernetes core/v1.LocalObjectReference + + + |
+
+ AvailableBucketClasses list the references of any supported BucketClass of this pool + |
+
+(Appears on:Bucket, BucketTemplateSpec) +
+BucketSpec defines the desired state of Bucket
+Field | +Description | +
---|---|
+bucketClassRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ BucketClassRef is the BucketClass of a bucket +If empty, an external controller has to provision the bucket. + |
+
+bucketPoolSelector + +map[string]string + + |
+
+ BucketPoolSelector selects a suitable BucketPoolRef by the given labels. + |
+
+bucketPoolRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ BucketPoolRef indicates which BucketPool to use for a bucket. +If unset, the scheduler will figure out a suitable BucketPoolRef. + |
+
+tolerations + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration + + + |
+
+ Tolerations define tolerations the Bucket has. Only any BucketPool whose taints +covered by Tolerations will be considered to host the Bucket. + |
+
string
alias)+(Appears on:BucketStatus) +
+BucketState represents the infrastructure state of a Bucket.
+Value | +Description | +
---|---|
"Available" |
+BucketStateAvailable reports whether a Bucket is available to be used. + |
+
"Error" |
+BucketStateError reports that a Bucket is in an error state. + |
+
"Pending" |
+BucketStatePending reports whether a Bucket is about to be ready. + |
+
+(Appears on:Bucket) +
+BucketStatus defines the observed state of Bucket
+Field | +Description | +
---|---|
+state + + +BucketState + + + |
+
+ State represents the infrastructure state of a Bucket. + |
+
+lastStateTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastStateTransitionTime is the last time the State transitioned between values. + |
+
+access + + +BucketAccess + + + |
+
+ Access specifies how to access a Bucket. +This is set by the bucket provider when the bucket is provisioned. + |
+
+conditions + + +[]BucketCondition + + + |
+
+ Conditions are the conditions of a bucket. + |
+
BucketTemplateSpec is the specification of a Bucket template.
+Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec + + +BucketSpec + + + |
+
+ + +
|
+
string
alias)+(Appears on:VolumeClass) +
+ResizePolicy is a type of policy.
+Value | +Description | +
---|---|
"ExpandOnly" |
+ResizePolicyExpandOnly is a policy that only allows the expansion of a Volume. + |
+
"Static" |
+ResizePolicyStatic is a policy that does not allow the expansion of a Volume. + |
+
+(Appears on:VolumeStatus) +
+VolumeAccess represents information on how to access a volume.
+Field | +Description | +
---|---|
+secretRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ SecretRef references the Secret containing the access credentials to consume a Volume. + |
+
+driver + +string + + |
+
+ Driver is the name of the drive to use for this volume. Required. + |
+
+handle + +string + + |
+
+ Handle is the unique handle of the volume. + |
+
+volumeAttributes + +map[string]string + + |
+
+ VolumeAttributes are attributes of the volume to use. + |
+
+(Appears on:VolumeStatus) +
+VolumeCondition is one of the conditions of a volume.
+Field | +Description | +
---|---|
+type + + +VolumeConditionType + + + |
+
+ Type is the type of the condition. + |
+
+status + + +Kubernetes core/v1.ConditionStatus + + + |
+
+ Status is the status of the condition. + |
+
+reason + +string + + |
+
+ Reason is a machine-readable indication of why the condition is in a certain state. + |
+
+message + +string + + |
+
+ Message is a human-readable explanation of why the condition has a certain reason / state. + |
+
+observedGeneration + +int64 + + |
+
+ ObservedGeneration represents the .metadata.generation that the condition was set based upon. + |
+
+lastTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastTransitionTime is the last time the status of a condition has transitioned from one state to another. + |
+
string
alias)+(Appears on:VolumeCondition) +
+VolumeConditionType is a type a VolumeCondition can have.
++(Appears on:VolumeSpec) +
+VolumeEncryption represents information to encrypt a volume.
+Field | +Description | +
---|---|
+secretRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ SecretRef references the Secret containing the encryption key to encrypt a Volume. +This secret is created by user with encryptionKey as Key and base64 encoded 256-bit encryption key as Value. + |
+
+(Appears on:VolumePoolStatus) +
+VolumePoolCondition is one of the conditions of a volume.
+Field | +Description | +
---|---|
+type + + +VolumePoolConditionType + + + |
+
+ Type is the type of the condition. + |
+
+status + + +Kubernetes core/v1.ConditionStatus + + + |
+
+ Status is the status of the condition. + |
+
+reason + +string + + |
+
+ Reason is a machine-readable indication of why the condition is in a certain state. + |
+
+message + +string + + |
+
+ Message is a human-readable explanation of why the condition has a certain reason / state. + |
+
+observedGeneration + +int64 + + |
+
+ ObservedGeneration represents the .metadata.generation that the condition was set based upon. + |
+
+lastTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastTransitionTime is the last time the status of a condition has transitioned from one state to another. + |
+
string
alias)+(Appears on:VolumePoolCondition) +
+VolumePoolConditionType is a type a VolumePoolCondition can have.
++(Appears on:VolumePool) +
+VolumePoolSpec defines the desired state of VolumePool
+Field | +Description | +
---|---|
+providerID + +string + + |
+
+ ProviderID identifies the VolumePool on provider side. + |
+
+taints + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint + + + |
+
+ Taints of the VolumePool. Only Volumes who tolerate all the taints +will land in the VolumePool. + |
+
string
alias)+(Appears on:VolumePoolStatus) +
+Value | +Description | +
---|---|
"Available" |
++ |
"Pending" |
++ |
"Unavailable" |
++ |
+(Appears on:VolumePool) +
+VolumePoolStatus defines the observed state of VolumePool
+Field | +Description | +
---|---|
+state + + +VolumePoolState + + + |
++ | +
+conditions + + +[]VolumePoolCondition + + + |
++ | +
+availableVolumeClasses + + +[]Kubernetes core/v1.LocalObjectReference + + + |
+
+ AvailableVolumeClasses list the references of any supported VolumeClass of this pool + |
+
+capacity + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Capacity represents the total resources of a machine pool. + |
+
+allocatable + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Allocatable represents the resources of a machine pool that are available for scheduling. + |
+
+(Appears on:Volume, VolumeTemplateSpec) +
+VolumeSpec defines the desired state of Volume
+Field | +Description | +
---|---|
+volumeClassRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ VolumeClassRef is the VolumeClass of a volume +If empty, an external controller has to provision the volume. + |
+
+volumePoolSelector + +map[string]string + + |
+
+ VolumePoolSelector selects a suitable VolumePoolRef by the given labels. + |
+
+volumePoolRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ VolumePoolRef indicates which VolumePool to use for a volume. +If unset, the scheduler will figure out a suitable VolumePoolRef. + |
+
+claimRef + + +github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference + + + |
+
+ ClaimRef is the reference to the claiming entity of the Volume. + |
+
+resources + + +github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList + + + |
+
+ Resources is a description of the volume’s resources and capacity. + |
+
+image + +string + + |
+
+ Image is an optional image to bootstrap the volume with. + |
+
+imagePullSecretRef + + +Kubernetes core/v1.LocalObjectReference + + + |
+
+ ImagePullSecretRef is an optional secret for pulling the image of a volume. + |
+
+unclaimable + +bool + + |
+
+ Unclaimable marks the volume as unclaimable. + |
+
+tolerations + + +[]github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration + + + |
+
+ Tolerations define tolerations the Volume has. Only any VolumePool whose taints +covered by Tolerations will be considered to host the Volume. + |
+
+encryption + + +VolumeEncryption + + + |
+
+ Encryption is an optional field which provides attributes to encrypt Volume. + |
+
string
alias)+(Appears on:VolumeStatus) +
+VolumeState represents the infrastructure state of a Volume.
+Value | +Description | +
---|---|
"Available" |
+VolumeStateAvailable reports whether a Volume is available to be used. + |
+
"Error" |
+VolumeStateError reports that a Volume is in an error state. + |
+
"Pending" |
+VolumeStatePending reports whether a Volume is about to be ready. + |
+
+(Appears on:Volume) +
+VolumeStatus defines the observed state of Volume
+Field | +Description | +
---|---|
+state + + +VolumeState + + + |
+
+ State represents the infrastructure state of a Volume. + |
+
+lastStateTransitionTime + + +Kubernetes meta/v1.Time + + + |
+
+ LastStateTransitionTime is the last time the State transitioned between values. + |
+
+access + + +VolumeAccess + + + |
+
+ Access specifies how to access a Volume. +This is set by the volume provider when the volume is provisioned. + |
+
+conditions + + +[]VolumeCondition + + + |
+
+ Conditions are the conditions of a volume. + |
+
VolumeTemplateSpec is the specification of a Volume template.
+Field | +Description | +||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata + + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||
+spec + + +VolumeSpec + + + |
+
+ + +
|
+
+Generated with gen-crd-api-reference-docs
+
The IronCore Runtime Interface (IRI) is a GRPC-based abstraction layer
+introduced to ease the implementation of a poollet
and pool provider
.
A poollet
does not have any knowledge how the resources are materialized and where the pool provider
runs.
+The responsibility of the poollet
is to collect and resolve the needed dependencies to materialize a resource.
A pool provider
implements the IRI, where the IRI defines the correct creation and management of resources
+handled by a pool provider
. A pool provider
of the IRI should follow the interface defined in the
+IRI APIs.
graph LR
+ P[poollet] --> IRI
+ IRI{IRI} --> B
+ B[pool provider]
+pool provider
¶A pool provider
represents a specific implementation of resources managed by
+a Pool. The implementation details of the pool provider
depend on the type of
+resource it handles, such as Compute or Storage resources.
Based on the implementation of a pool provider
it can serve multiple use-cases:
+- to broker resources between different clusters e.g. volume-broker
+- to materialize resources e.g. block devices created in a Ceph cluster via the cephlet
The IRI defines several interface methods categIRIzed into Compute, Storage, +and Bucket.
+ +The IRI definition can be extended in the future with new resource groups.
+Below is a diagram illustrating the relationship between poollets
,
+IRI, and pool providers
in the ironcore
project.
graph TB
+ A[Machine] -- scheduled on --> B[MachinePool]
+ C[Volume] -- scheduled on --> D[VolumePool]
+ B -- announced by --> E[machinepoollet]
+ D -- announced by --> F[volumepoollet]
+ E -- GRPC calls --> G[IRI compute provider]
+ F -- GRPC calls --> H[IRI storage provider]
+ G -.sidecar to.- E
+ H -.sidecar to.- F
+This diagram illustrates:
+Machine
resources are scheduled on a MachinePool
which is announced by the machinepoollet
.Volume
resources are scheduled on a VolumePool
which is announced by the volumepoollet
.machinepoollet
and volumepoollet
each have an IRI provider
sidecar, which provides a GRPC interface for
+making calls to create, update, or delete resources.provider
(Compute) is a sidecar to the machinepoollet
and the IRI provider
(Storage) is a sidecar to the
+volumepoollet
. They handle GRPC calls from their respective poollets
and interact with the actual resources.