Skip to content

Commit 4858324

Browse files
authored
Merge pull request #19 from chaitanya1731/readme-cleanup
Readme: Updated README.md
2 parents d6e203d + 9424dfe commit 4858324

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Disclaimer
22
This project is currently under active development, and as such, all source code may not be included in any release. This means that the code is subject to change without notice, and that any information contained within the code should be considered as work in progress.
33

4-
# Intel Technology Enabling for OpenShift
4+
# Intel® Technology Enabling for OpenShift*
55
## General
66

77
Intel® Technology Enabling for OpenShift* project provides Intel data center and edge hardware features provisioning, related E2E solutions and the reference workloads for these Intel features on Red Hat OpenShift platform.
@@ -11,35 +11,30 @@ The goal of the project is to develop and release open, easy-to-use, integrated,
1111
To achieve this goal, following OCP software stack development and management life cycle should be followed:
1212

1313
* The related software stacks must be designed and implemented properly for Cloud Native and OCP environment from Day 0
14-
* The solutions and instructions must allow users to configure and provision their OCP cluster properly with technologies from intel and other vendors on Day 1
15-
* The solutions and instructions to provision intel hardware features and manage the life cycle of containerized software stack must be present in Day 2
16-
17-
Multiple other opens source projects are used to provide the solutions. This GitHub project can also be used as an interface for users to access related projects and acquire support from open-source community. People are encouraged to use this project issue to report bugs and request features. Which can help them easily adopt Intel technologies with OCP and cloud-native environments.
18-
19-
As the downstream project, this project embodies upstream-first policy. None of the upstream projects will be forked, and no specific patches will be maintained in the project. The proper open-source feature request and bug triage process will be enforced before performing feature design, development, and bug fixes in the specific upstream projects. Everything must be down streamed to the OCP project before being used by the project.
14+
* The solutions and instructions must allow users to configure and provision their OCP cluster properly with technologies from Intel and other vendors on Day 1
15+
* The solutions and instructions to provision Intel hardware features and manage the life cycle of containerized software stack must be present in Day 2
2016

2117
## Intel Hardware features Provisioning for OpenShift
2218

23-
To provision Intel Hardware features on OCP, following open-source projects are used:
19+
To provision Intel hardware features on OCP, following open-source projects are used:
2420
* **[Node Feature Discovery (NFD)](https://github.com/kubernetes-sigs/node-feature-discovery), [NFD Operator](https://github.com/openshift/cluster-nfd-operator)** are used to automatically label the nodes for Hardware provisioning operation.
2521
* **[Machine Config Operator (MCO)](https://github.com/openshift/machine-config-operator)** is used to configure the Red Hat Enterprise Linux Core OS (RHCOS) on the nodes.
2622
* **[Kernel Module Management (KMM)](https://github.com/kubernetes-sigs/kernel-module-management), [KMM Operator](https://github.com/rh-ecosystem-edge/kernel-module-management)** are used to manage deployment and lifecycle of Intel Data Center GPU Driver.
27-
* **[Intel Data Center GPU Driver For OpenShift](https://github.com/intel/intel-data-center-gpu-driver-for-openshift)** use **[Intel GPU Drivers](https://github.com/intel-gpu)** build, package certificate and release Intel dGPU driver container images for OCP.
23+
* **[Intel Data Center GPU Driver For OpenShift](https://github.com/intel/intel-data-center-gpu-driver-for-openshift)** use **[Intel GPU Drivers](https://github.com/intel-gpu)** build, package, certify and release Intel Data Center GPU driver container images for OCP.
2824
* **[Intel Device Plugins for Kubernetes project](https://github.com/intel/intel-device-plugins-for-kubernetes)** Provides Intel GPU/SGX/QAT device plugins images and the operator to deploy and manage the life cycle of these device plugins
2925

30-
Intel Hardware features include:
26+
Intel hardware features include:
3127

3228
* **Intel® Software Guard Extensions (Intel® SGX)**
33-
* **Intel® Data Center GPU Flex Series (Intel® dGPU)**
29+
* **Intel® Data Center GPU Flex Series**
3430
* **Intel® QuickAssist Technology (Intel® QAT)**
3531

36-
Below features are under consideration to be included in the future releases
32+
Below features are under consideration to be included in the future releases:
3733

3834
* Intel® Data Center GPU Max Series
3935
* Intel® Data Streaming Accelerator (Intel® DSA)
4036
* Intel® In-Memory Analytics Accelerator (Intel® IAA)
4137
* Intel® Dynamic Load Balancer (Intel® DLB)
42-
* Intel® Movidius™ Vision Processing Units
4338

4439
## [Intel AI Inference E2E Solution for OpenShift](e2e/inference/README.md)
4540

@@ -50,7 +45,7 @@ Below features are under consideration to be included in the future releases
5045
* Third Generation Intel® Xeon® Scalable Processors (or later version) are used by the cluster.
5146
* Contact your server or BIOS vendor for the BIOS setting to enable the feature.
5247

53-
### Intel® dGPU Card supported platform
48+
### Intel® Data Center GPU Card supported platform
5449

5550
* The Intel® Data Center GPU Flex Series 140 or Intel® Data Center GPU Flex Series 170 Card is enabled on the nodes.
5651
* Contact your server or BIOS vendor for the BIOS setting to enable the cards.
@@ -60,30 +55,30 @@ Below features are under consideration to be included in the future releases
6055
* Contact your server or BIOS vendor for the BIOS setting to enable the feature.
6156

6257
## Get Started
63-
To properly provision Intel Hardware features, deploy and manage the related e2e solutions as well as the reference workload, below OCP software stack development and life cycle management flow is followed by this project
58+
To properly provision Intel hardware features, deploy and manage the related E2E solutions as well as the reference workload, below OCP software stack development and life cycle management flow is followed by this project
6459

6560
### Day 0 - Define the requirements of the OCP platform and design it.
6661
Red Hat [OpenShift Operator](https://www.redhat.com/en/technologies/cloud-computing/openshift/what-are-openshift-operators) automates the creation, configuration, and management of instances of Kubernetes-native applications. It is based on [Kubernetes operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). So the software stack running on OCP needs to be containerized and managed by a specific Operator. As an essential part of OCP, operators need to be well-designed from Day 0. Good examples are [Intel Device Plugins Operator](https://github.com/intel/intel-device-plugins-for-kubernetes) and [KMM Operator](https://github.com/rh-ecosystem-edge/kernel-module-management).
6762

68-
### Day 1 - provision the OCP platform and configure it to a working state.
69-
This project mainly focuses on bare metal OCP cluster. [DCI](https://doc.distributed-ci.io/dci-openshift-agent/) is used to provision the bare metal OCP cluster. Users can also refer to [bare metal OCP cluster installation instructions](https://docs.openshift.com/container-platform/4.11/installing/installing_bare_metal_ipi/ipi-install-overview.html) to install the bare metal OCP cluster.
63+
### Day 1 - Provision the OCP platform and configure it to a working state.
64+
This project mainly focuses on bare metal OCP cluster. [Distributed CI](https://doc.distributed-ci.io/dci-openshift-agent/) is used to provision the bare metal OCP cluster. Users can also refer to [bare metal OCP cluster installation instructions](https://docs.openshift.com/container-platform/4.12/installing/installing_bare_metal_ipi/ipi-install-overview.html) to install the bare metal OCP cluster.
7065

71-
To avoid rebooting the nodes and some other issues on Day 2, Some Machine Configurations operations can be enforced on day 1 when provisioning the cluster. The related discussion is ongoing.
66+
To avoid rebooting the nodes and some other issues on Day 2, Some machine configurations operations can be enforced on day 1 when provisioning the cluster. The related discussion is ongoing.
7267

7368
### Day 2.0 - Zero O’clock of Day 2
74-
The Day 2.0 concept is introduced for users to provision intel hardware features right after provisioning an OCP cluster and before any user workloads are deployed. Refer to the steps below to provision Intel hardware features:
69+
The Day 2.0 concept is introduced for users to provision Intel hardware features right after provisioning an OCP cluster and before any user workloads are deployed. Refer to the steps below to provision Intel hardware features:
7570

76-
* **[Deploy Node Feature Descovery on OpenShift](nfd/README.md#steps-to-install-and-configure-nfd-operator-on-ocp-cluster)**
71+
* **[Deploy Node Feature Discovery on OpenShift](nfd/README.md#steps-to-install-and-configure-nfd-operator-on-ocp-cluster)**
7772
* **[Setup Machine Configuration on OpenShift](machine_configuration/README.md#general-configuration-for-provisioning-intel-hardware-features)**
7873

7974
Note: Running the above steps on Day 2.0 is recommended. However, if you want to provision the features above with the existing cluster on day 2, please be advised that some machine configuration operations might trigger the pods to drain and reboot the nodes. Some of the ongoing efforts in the MCO upstream are to set the machine configurations without rebooting.
8075

8176
### Day 2 - OCP platform is installed and ready to begin providing services.
82-
Multiple operators are used to provision Intel hardware features and deploy, manage the e2e solutions, and reference workloads.
77+
Multiple operators are used to provision Intel hardware features and deploy, manage the E2E solutions, and reference workloads.
8378

8479
**Provisioning Intel Hardware features on OpenShift**
8580
* **[Deploy Intel Data Center GPU Driver on OpenShift](kmmo/README.md#managing-intel-dgpu-driver-with-kmm-operator)**
8681
* **[Deploy Intel Device Plugins on OpenShift](device_plugins/README.md#deploy-intel-device-plugins-on-openshift)**
8782

8883
**Deploy E2E Solution**
89-
* **[Deploy Intel AI Reference E2E Solution](e2e/inference/README.md#deploy-intel-ai-inference-e2e-solution)**
84+
* **[Deploy Intel AI Reference E2E Solution](e2e/inference/README.md#deploy-intel-ai-inference-e2e-solution)**

0 commit comments

Comments
 (0)