fix typos and other minor errors

Author: Rohit-0505

api/common/v1alpha1/common_types_test.go

@@ -9,7 +9,7 @@ import (
 )
 
 var _ = Describe("TolerateTaints", func() {
-	It("returns true upon empty taints", func() {
+	It("should return true upon empty taints", func() {
 		Expect(TolerateTaints(nil, nil)).To(BeTrue(), "expected empty tolerations tolerate empty taints")
 
 		tolerations := []Toleration{
@@ -22,7 +22,7 @@ var _ = Describe("TolerateTaints", func() {
 		Expect(TolerateTaints(tolerations, nil)).To(BeTrue(), "expected non-empty tolerations tolerate empty taints")
 	})
 
-	It("returns false upon empty tolerations and non-empty taints", func() {
+	It("should return false upon empty tolerations and non-empty taints", func() {
 		taints := []Taint{
 			{
 				Key:    "key",
@@ -32,7 +32,7 @@ var _ = Describe("TolerateTaints", func() {
 		Expect(TolerateTaints(nil, taints)).To(BeFalse(), "expected empty tolerations don't tolerate non-empty taints")
 	})
 
-	It("returns false when tolerations don't cover all taints", func() {
+	It("should return false when tolerations don't cover all taints", func() {
 		tolerations := []Toleration{
 			{
 				Key:      "key",
@@ -54,7 +54,7 @@ var _ = Describe("TolerateTaints", func() {
 		Expect(TolerateTaints(tolerations, taints)).To(BeFalse(), "expected the tolerations don't cover all the taints")
 	})
 
-	It("returns false when tolerations cover all taints", func() {
+	It("should return false when tolerations cover all taints", func() {
 		tolerations := []Toleration{
 			{
 				Key:      "key",

api/compute/v1alpha1/machine_types.go

@@ -122,7 +122,7 @@ type EmptyDiskVolumeSource struct {
 	SizeLimit *resource.Quantity `json:"sizeLimit,omitempty"`
 }
 
-// NetworkInterfaceStatus reports the status of an NetworkInterfaceSource.
+// NetworkInterfaceStatus reports the status of a NetworkInterfaceSource.
 type NetworkInterfaceStatus struct {
 	// Name is the name of the NetworkInterface to whom the status belongs to.
 	Name string `json:"name"`

api/networking/v1alpha1/loadbalancerrouting_type.go

@@ -20,7 +20,7 @@ type LoadBalancerRouting struct {
 	// NetworkRef is the network the load balancer is assigned to.
 	NetworkRef commonv1alpha1.LocalUIDReference `json:"networkRef"`
 
-	// Destinations are the destinations for an LoadBalancer.
+	// Destinations are the destinations for a LoadBalancer.
 	Destinations []LoadBalancerDestination `json:"destinations"`
 }
 

client-go/openapi/zz_generated.openapi.go

@@ -1380,7 +1380,7 @@ NetworkInterface to use.</p>
 (<em>Appears on:</em><a href="#compute.ironcore.dev/v1alpha1.MachineStatus">MachineStatus</a>)
 </p>
 <div>
-<p>NetworkInterfaceStatus reports the status of an NetworkInterfaceSource.</p>
+<p>NetworkInterfaceStatus reports the status of a NetworkInterfaceSource.</p>
 </div>
 <table>
 <thead>

docs/api-reference/compute.md

@@ -244,7 +244,7 @@ github.com/ironcore-dev/ironcore/api/common/v1alpha1.LocalUIDReference
 </em>
 </td>
 <td>
-<p>Destinations are the destinations for an LoadBalancer.</p>
+<p>Destinations are the destinations for a LoadBalancer.</p>
 </td>
 </tr>
 </tbody>

docs/api-reference/networking.md

@@ -5,7 +5,7 @@ The `exec` feature allows accessing the serial console of a
 The following parties are involved in implementing `exec`:
 
 * `ironcore-apiserver`
-* `machinepollet`
+* `machinepoollet`
 * `iri-machine` implementor
 
 The connection flow between those components looks like the following:

docs/concepts/machine-exec-flow.md

@@ -65975,7 +65975,7 @@
 					"type": "string"
 				},
 				"destinations": {
-					"description": "Destinations are the destinations for an LoadBalancer.",
+					"description": "Destinations are the destinations for a LoadBalancer.",
 					"type": "array",
 					"items": {
 						"$ref": "#/definitions/com.github.ironcore-dev.ironcore.api.networking.v1alpha1.LoadBalancerDestination"
@@ -71520,7 +71520,7 @@
 					"$ref": "#/definitions/io.k8s.api.batch.v1.PodFailurePolicy"
 				},
 				"podReplacementPolicy": {
-					"description": "podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods\n  when they are terminating (has a metadata.deletionTimestamp) or failed.\n- Failed means to wait until a previously created Pod is fully terminated (has phase\n  Failed or Succeeded) before creating a replacement Pod.\n\nWhen using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.\n\nPossible enum values:\n - `\"Failed\"` means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod.\n - `\"TerminatingOrFailed\"` means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed.",
+					"description": "podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods\n  when they are terminating (has a metadata.deletionTimestamp) or failed.\n- Failed means to wait until a previously created Pod is fully terminated (has phase\n  Failed or Succeeded) before creating a replacement Pod.\n\nWhen using podFailurePolicy, Failed is the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is a beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.\n\nPossible enum values:\n - `\"Failed\"` means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod.\n - `\"TerminatingOrFailed\"` means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed.",
 					"type": "string",
 					"enum": [
 						"Failed",
@@ -71888,7 +71888,7 @@
 			],
 			"properties": {
 				"expirationSeconds": {
-					"description": "expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration.\n\nThe v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager.\n\nCertificate signers may not honor this field for various reasons:\n\n  1. Old signer that is unaware of the field (such as the in-tree\n     implementations prior to v1.22)\n  2. Signer whose configured maximum is shorter than the requested duration\n  3. Signer whose configured minimum is longer than the requested duration\n\nThe minimum valid value for expirationSeconds is 600, i.e. 10 minutes.",
+					"description": "expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and notAfter fields in the issued certificate to determine the actual duration.\n\nThe v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager.\n\nCertificate signers may not honor this field for various reasons:\n\n  1. Old signer that is unaware of the field (such as the in-tree\n     implementations prior to v1.22)\n  2. Signer whose configured maximum is shorter than the requested duration\n  3. Signer whose configured minimum is longer than the requested duration\n\nThe minimum valid value for expirationSeconds is 600, i.e. 10 minutes.",
 					"type": "integer",
 					"format": "int32"
 				},
@@ -76493,7 +76493,7 @@
 					"x-kubernetes-patch-strategy": "merge"
 				},
 				"initContainers": {
-					"description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/",
+					"description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/",
 					"type": "array",
 					"items": {
 						"$ref": "#/definitions/io.k8s.api.core.v1.Container"
@@ -82686,7 +82686,7 @@
 			}
 		},
 		"io.k8s.apimachinery.pkg.api.resource.Quantity": {
-			"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` <quantity>        ::= <signedNumber><suffix>\n\n\t(Note that <suffix> may be empty, from the \"\" case in <decimalSI>.)\n\n<digit>           ::= 0 | 1 | ... | 9 <digits>          ::= <digit> | <digit><digits> <number>          ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign>            ::= \"+\" | \"-\" <signedNumber>    ::= <number> | <sign><number> <suffix>          ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI>        ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n<decimalSI>       ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n<decimalExponent> ::= \"e\" <signedNumber> | \"E\" <signedNumber> ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.",
+			"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` <quantity>        ::= <signedNumber><suffix>\n\n\t(Note that <suffix> may be empty, from the \"\" case in <decimalSI>.)\n\n<digit>           ::= 0 | 1 | ... | 9 <digits>          ::= <digit> | <digit><digits> <number>          ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign>            ::= \"+\" | \"-\" <signedNumber>    ::= <number> | <sign><number> <suffix>          ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI>        ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n<decimalSI>       ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n<decimalExponent> ::= \"e\" <signedNumber> | \"E\" <signedNumber> ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that will cause implementors to also use a fixed point implementation.",
 			"type": "string"
 		},
 		"io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup": {
@@ -84680,4 +84680,4 @@
 			"BearerToken": []
 		}
 	]
-}
+}