Skip to content

Commit a322152

Browse files
authored
Typos and minor rewordings (#88)
* doc: typos * doc: minor rewordings
1 parent bfd1d88 commit a322152

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

docs/baremetal/architecture/discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ apiVersion: metal.ironcore.dev/v1alpha1
141141
kind: ServerBootConfiguration
142142
metadata:
143143
name: my-server-boot-config
144-
namespace: defauilt
144+
namespace: default
145145
spec:
146146
serverRef:
147147
name: my-server

docs/iaas/architecture/networking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
IronCore's virtual networking architecture provides an end-to-end virtual networking solution for provisioned `Machine`s running in data centers, regardless they are baremetal machines or virtual machines. It is designed to enable robust, flexible and performing networking control plane and data plane.
66

7-
- **Robust**: IronCore's virtual netowrking control plane is mainly implemented using Kubernetes controller model. Thus, it is able to survive component's failure and recover the running states by retrieving the desired networking configuration.
7+
- **Robust**: IronCore's virtual networking control plane is mainly implemented using Kubernetes controller model. Thus, it is able to survive component's failure and recover the running states by retrieving the desired networking configuration.
88
- **Flexible**: Thanks to the modular and layered architecture design, IronCore's virtual networking solution allows developers to implement and interchange components from the most top-level data center management system built upon defined IronCore APIs, to lowest-level packet processing engines depending on the used hardware.
9-
- **Performing**: The data plane of IronCore's virtual networking solution is built with the state-of-the-art packet processing framework, [DPDK](https://www.dpdk.org), and currently utilizes the hardware offloading features of [Nvidia's Mellanox SmartNic serials](https://www.nvidia.com/en-us/networking/ethernet-adapters/) to speedup packet processing. With the DPDK's run-to-completion model, IronCore's networking data plane can achieve high performance even in the environment where hardware offloading capability is limited or disabled.
9+
- **Performing**: The data plane of IronCore's virtual networking solution is built with the packet processing framework [DPDK](https://www.dpdk.org), and currently utilizes the hardware offloading features of [Nvidia's Mellanox SmartNic serials](https://www.nvidia.com/en-us/networking/ethernet-adapters/) to speedup packet processing. With the DPDK's run-to-completion model, IronCore's networking data plane can achieve high performance even in the environment where hardware offloading capability is limited or disabled.
1010

1111
IronCore's virtual networking architecture is illustrated with the following figure. It consists of several components that work together to ensure network out and inbound connectivity and isolation for `Machine` instances.
1212

docs/iaas/architecture/os-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ IronCore are used both for virtual machine creation in the [Infrastructure as a
77
as they represent a full operating system rather than just a single application or service.
88

99
The core idea behind using OCI as a means to manage operating system images is to leverage any OCI compliant image registry,
10-
to publsish and share operating system images. This can be done by using a public registry or host your own private registry.
10+
to publish and share operating system images. This can be done by using a public registry or host your own private registry.
1111

1212
## OCI Image Format
1313

docs/iaas/architecture/providers/brokers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Below is an example of how a `machinepoollet` and `machinebroker` will translate
88

99
![Brokers](/brokers.png)
1010

11-
Brokers are useful in scenarios where I want to run IronCore not in a single cluster but rather have a federated
11+
Brokers are useful in scenarios where IronCore should not run in a single cluster but rather have a federated
1212
environment. For example, in a federated environment, every hypervisor node in a compute cluster would announce it's
1313
`MachinePool` inside the compute cluster. A `MachinePoollet`/`MachineBroker` in this compute cluster could now announce
1414
a logical `MachinePool` "one level up" as a logical compute pool in e.g. an availability zone cluster. The broker concept

docs/iaas/architecture/scheduling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ an entity onto which resources can be scheduled. The announcement of a `Pool` re
1111
also provides in the `Pool` status the `AvailableMachineClasses` a `Pool` supports. A `Class` in this context represents
1212
a list of resource-specific capabilities that a `Pool` can provide, such as CPU, memory, and storage.
1313

14-
`Pools` and `Classes` are defined for all major resource types in IronCore, including compute, storage. Resources in the
14+
`Pools` and `Classes` are defined for all major resource types in IronCore, including compute and storage. Resources in the
1515
`networking` API have no `Pool` concept, as they are not scheduled but rather provided on-demand by the network related
1616
components. The details are described in the [networking section](/iaas/architecture/networking).
1717

0 commit comments

Comments
 (0)