diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/development/.buildinfo b/development/.buildinfo new file mode 100644 index 00000000..8e237a28 --- /dev/null +++ b/development/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 6c080dd147adf59993388e4750b05761 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/development/CODE_OF_CONDUCT.html b/development/CODE_OF_CONDUCT.html new file mode 100644 index 00000000..84ba7a37 --- /dev/null +++ b/development/CODE_OF_CONDUCT.html @@ -0,0 +1,255 @@ + + + + + + + Contributor Covenant Code of Conduct — Intel® Technology Enabling for OpenShift* + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Contributor Covenant Code of Conduct

+
+

Our Pledge

+

We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation.

+

We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community.

+
+
+

Our Standards

+

Examples of behavior that contributes to a positive environment for our +community include:

+
    +

  • Demonstrating empathy and kindness toward other people

    • +

  • Being respectful of differing opinions, viewpoints, and experiences

    • +

  • Giving and gracefully accepting constructive feedback

    • +

  • Accepting responsibility and apologizing to those affected by our mistakes, +and learning from the experience

    • +

  • Focusing on what is best not just for us as individuals, but for the overall +community

    • +
+

Examples of unacceptable behavior include:

+
    +

  • The use of sexualized language or imagery, and sexual attention or advances of +any kind

    • +

  • Trolling, insulting or derogatory comments, and personal or political attacks

    • +

  • Public or private harassment

    • +

  • Publishing others’ private information, such as a physical or email address, +without their explicit permission

    • +

  • Other conduct which could reasonably be considered inappropriate in a +professional setting

    • +
+
+
+

Enforcement Responsibilities

+

Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful.

+

Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate.

+
+
+

Scope

+

This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event.

+
+
+

Enforcement

+

Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +CommunityCodeOfConduct AT intel DOT com. +All complaints will be reviewed and investigated promptly and fairly.

+

All community leaders are obligated to respect the privacy and security of the +reporter of any incident.

+
+
+

Enforcement Guidelines

+

Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct:

+
+

1. Correction

+

Community Impact: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community.

+

Consequence: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested.

+
+
+

2. Warning

+

Community Impact: A violation through a single incident or series of +actions.

+

Consequence: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban.

+
+
+

3. Temporary Ban

+

Community Impact: A serious violation of community standards, including +sustained inappropriate behavior.

+

Consequence: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban.

+
+
+

4. Permanent Ban

+

Community Impact: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals.

+

Consequence: A permanent ban from any sort of public interaction within the +community.

+
+
+
+

Attribution

+

This Code of Conduct is adapted from the Contributor Covenant, +version 2.1, available at +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

+

Community Impact Guidelines were inspired by +Mozilla’s code of conduct enforcement ladder.

+

For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +[https://www.contributor-covenant.org/translations][translations].

+
+
+ + +
+
+ +
+
+
+
+ +
+ + Versions + development + + +
+ +
+
Versions
+ + +
development
+ + +
+ +
+
+ + + \ No newline at end of file diff --git a/development/CONTRIBUTING.html b/development/CONTRIBUTING.html new file mode 100644 index 00000000..70faf18e --- /dev/null +++ b/development/CONTRIBUTING.html @@ -0,0 +1,191 @@ + + + + + + + Contributing — Intel® Technology Enabling for OpenShift* + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Contributing

+
+

License

+

Intel Technology Enabling For OpenShift project is licensed under the terms in Apache-2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.

+
+
+

Sign your work

+

Please use the sign-off line at the end of the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify +the below (from developercertificate.org):

+
Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+
+
+

Then you just add a line to every git commit message:

+
Signed-off-by: Joe Smith <joe.smith@email.com>
+
+
+

Use your real name (sorry, no pseudonyms or anonymous contributions.)

+

If you set your user.name and user.email git configs, you can sign your +commit automatically with git commit -s.

+
+
+ + +
+
+ +
+
+
+
+ +
+ + Versions + development + + +
+ +
+
Versions
+ + +
development
+ + +
+ +
+
+ + + \ No newline at end of file diff --git a/development/README.html b/development/README.html new file mode 100644 index 00000000..05019f98 --- /dev/null +++ b/development/README.html @@ -0,0 +1,279 @@ + + + + + + + Intel® Technology Enabling for OpenShift* — Intel® Technology Enabling for OpenShift* + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Intel® Technology Enabling for OpenShift*

+
+

Overview

+

The Intel Technology Enabling for OpenShift project provides Intel Data Center hardware feature-provisioning technologies with the Red Hat OpenShift Container Platform (RHOCP). The technology to deploy and manage the End-to-End (E2E) solutions as well as the related reference workloads for these features are also included in the project.

+

These Intel Data Center hardware features currently include:

+
    +

  • Intel® Software Guard Extensions (Intel® SGX)

    • +

  • Intel® Data Center GPU Flex Series

    • +

  • Intel® Data Center GPU Max Series

    • +

  • Intel® QuickAssist Technology (Intel® QAT)

    • +
+

The following features will be included in future releases.

+
    +

  • Intel® Data Streaming Accelerator (Intel® DSA)

    • +

  • Intel® In-Memory Analytics Accelerator (Intel® IAA)

    • +

  • Intel® FPGA N6000

    • +
+

See details about Supported Intel Hardware features and Supported RHOCP Versions.

+

For detailed information about releases, please refer Release Information.

+

Figure-1 is the Architecture and Working Scope of the project

+

Alt text

+
+ Figure-1 Intel Technology Enabling for OpenShift Architecture +
+
+
+

Supported platforms

+

This section describes the RHOCP infrastructure and Intel hardware features supported by this project. The project lifecycle and support channels can also be found here.

+
+
+

Getting started

+

See reference BIOS Configuration required for each feature.

+
+

Provisioning RHOCP cluster

+

Use one of these two options to provision an RHOCP cluster:

+ +

In this project, we provisioned RHOCP 4.14 on a bare-metal multi-node cluster. For details about the supported RHOCP infrastructure, see the Supported Platforms page.

+
+
+

Provisioning Intel hardware features on RHOCP

+

Please follow the steps below to provision the hardware features

+
    +

  1. Setting up Node Feature Discovery

    2. +

  2. Setting up Machine Configuration

    3. +

  3. Setting up Out of Tree Drivers

    4. +

  4. Setting up Device Plugins

    5. +
+
+
+

Verifying hardware feature provisioning

+

You can use the instructions in the link to verify the hardware features provisioning.

+
+
+
+

Upgrade (To be added)

+
+
+

Reference end-to-end solution

+

The reference end-to-end solution is based on Intel hardware feature provisioning provided by this project.

+

Intel AI Inferencing Solution with OpenVINO and RHOAI

+
+
+

Reference workloads

+

Here are some reference workloads built on the end-to-end solution and Intel hardware feature provisioning in this project.

+
    +

  • Large Language Model (To be added)

    • +

  • Open Federated Learning (To be added)

    • +
+
+
+

Advanced Guide

+

This section discusses architecture and other technical details that go beyond getting started.

+ +
+
+

Release Notes

+

Check the link for the Release Notes.

+
+
+

Support

+

If users encounter any issues or have questions regarding Intel Technology Enabling for OpenShift, we recommend them to seek support through the following channels:

+
+

Commercial support from Red Hat

+

This project relies on features developed and released with the latest RHOCP release. Commercial RHOCP release support is outlined in the Red Hat OpenShift Container Platform Life Cycle Policy and Intel collaborates with Red Hat to address specific requirements from our users.

+
+

Open-Source Community Support

+

Intel Technology Enabling for OpenShift is run as an open-source project on GitHub. Project GitHub issues can be used as the primary support interface for users to submit feature requests and report issues to the community when using Intel technology provided by this project. Please provide detailed information about your issue and steps to reproduce it, if possible.

+
+
+
+
+

Contribute

+

See CONTRIBUTING for more information.

+
+
+

Security

+

To report a potential security vulnerability, please refer to security.md file.

+
+
+

License

+

Distributed under the open source license. See LICENSE for more information.

+
+
+

Code of Conduct

+

Intel has adopted the Contributor Covenant as the Code of Conduct for all of its open source projects. See CODE_OF_CONDUCT file.

+
+
+ + +
+
+ +
+
+
+
+ +
+ + Versions + development + + +
+ +
+
Versions
+ + +
development
+ + +
+ +
+
+ + + \ No newline at end of file diff --git a/development/_downloads/61e0bdf7e1b43c5c93d9488b22e04170/LICENSE.txt b/development/_downloads/61e0bdf7e1b43c5c93d9488b22e04170/LICENSE.txt new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/development/_downloads/61e0bdf7e1b43c5c93d9488b22e04170/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/development/_downloads/69368102d75fa35b72230921fd685d2d/intel-dgpu.yaml b/development/_downloads/69368102d75fa35b72230921fd685d2d/intel-dgpu.yaml new file mode 100644 index 00000000..40c8789d --- /dev/null +++ b/development/_downloads/69368102d75fa35b72230921fd685d2d/intel-dgpu.yaml @@ -0,0 +1,24 @@ +# Copyright (c) 2022 - 2023 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + +apiVersion: kmm.sigs.x-k8s.io/v1beta1 +kind: Module +metadata: + name: intel-dgpu + namespace: openshift-kmm +spec: + moduleLoader: + container: + modprobe: + moduleName: i915 + firmwarePath: /firmware + modulesLoadingOrder: + - i915 + - mei_gsc + inTreeModulesToRemove: [i915, intel_vsec, mei_gsc, mei_me] + kernelMappings: + - regexp: '^.*\.x86_64$' + containerImage: registry.connect.redhat.com/intel/intel-data-center-gpu-driver-container:2.2.0-$KERNEL_FULL_VERSION + selector: + intel.feature.node.kubernetes.io/gpu: 'true' + intel.feature.node.kubernetes.io/dgpu-canary: 'true' diff --git a/development/_downloads/d7680499f3a30a9d47976f0f38439d17/gpu_device_plugin.yaml b/development/_downloads/d7680499f3a30a9d47976f0f38439d17/gpu_device_plugin.yaml new file mode 100644 index 00000000..9db56c06 --- /dev/null +++ b/development/_downloads/d7680499f3a30a9d47976f0f38439d17/gpu_device_plugin.yaml @@ -0,0 +1,15 @@ +# Copyright (c) 2023 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + +apiVersion: deviceplugin.intel.com/v1 +kind: GpuDevicePlugin +metadata: + name: gpudeviceplugin-sample +spec: + image: registry.connect.redhat.com/intel/intel-gpu-plugin@sha256:4d3d11a87e22c94c41bd9c38a09a966c3ab893f8264b19cdc4cc2d9be22eff3c + initImage: registry.connect.redhat.com/intel/intel-gpu-initcontainer@sha256:cf358c292ba8e43ea418f2f9d9dc6661bd146cc2ea411ea62f5d3d29418ed959 + preferredAllocationPolicy: none + sharedDevNum: 1 + logLevel: 4 + nodeSelector: + intel.feature.node.kubernetes.io/gpu: "true" \ No newline at end of file diff --git a/development/_downloads/d7713c814c6f11263d4352e35f0826f0/install_operator.yaml b/development/_downloads/d7713c814c6f11263d4352e35f0826f0/install_operator.yaml new file mode 100644 index 00000000..92ebc66d --- /dev/null +++ b/development/_downloads/d7713c814c6f11263d4352e35f0826f0/install_operator.yaml @@ -0,0 +1,23 @@ +# Copyright (c) 2023 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + +apiVersion: operators.coreos.com/v1alpha2 +kind: OperatorGroup +metadata: + name: global-operators + namespace: openshift-operators +--- +apiVersion: operators.coreos.com/v1alpha1 +kind: Subscription +metadata: + labels: + operators.coreos.com/intel-device-plugins-operator.openshiftoperators: "" + name: intel-device-plugins-operator + namespace: openshift-operators +spec: + channel: alpha + installPlanApproval: Automatic + name: intel-device-plugins-operator + source: certified-operators + sourceNamespace: openshift-marketplace + startingCSV: intel-device-plugins-operator.v0.28.0 \ No newline at end of file diff --git a/development/_images/Intel-Technology-Enabling-for-OpenShift-Architecture.png b/development/_images/Intel-Technology-Enabling-for-OpenShift-Architecture.png new file mode 100644 index 00000000..6fca3b0f Binary files /dev/null and b/development/_images/Intel-Technology-Enabling-for-OpenShift-Architecture.png differ diff --git a/development/_images/Ovms-Gpu-resource-limit.png b/development/_images/Ovms-Gpu-resource-limit.png new file mode 100644 index 00000000..a97e93b5 Binary files /dev/null and b/development/_images/Ovms-Gpu-resource-limit.png differ diff --git a/development/_images/Ovms-Gpu-resource-request.png b/development/_images/Ovms-Gpu-resource-request.png new file mode 100644 index 00000000..a863dec7 Binary files /dev/null and b/development/_images/Ovms-Gpu-resource-request.png differ diff --git a/development/_images/accelerator-profile-dropdown.png b/development/_images/accelerator-profile-dropdown.png new file mode 100644 index 00000000..26029926 Binary files /dev/null and b/development/_images/accelerator-profile-dropdown.png differ diff --git a/development/_images/openvino-accelerator-field.png b/development/_images/openvino-accelerator-field.png new file mode 100644 index 00000000..ed2e55fc Binary files /dev/null and b/development/_images/openvino-accelerator-field.png differ diff --git a/development/_images/rhods-dashboard-route.png b/development/_images/rhods-dashboard-route.png new file mode 100644 index 00000000..54c29954 Binary files /dev/null and b/development/_images/rhods-dashboard-route.png differ diff --git a/development/_sources/CODE_OF_CONDUCT.md.txt b/development/_sources/CODE_OF_CONDUCT.md.txt new file mode 100644 index 00000000..58dba18d --- /dev/null +++ b/development/_sources/CODE_OF_CONDUCT.md.txt @@ -0,0 +1,131 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +CommunityCodeOfConduct AT intel DOT com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq diff --git a/development/_sources/CONTRIBUTING.md.txt b/development/_sources/CONTRIBUTING.md.txt new file mode 100644 index 00000000..04af01f0 --- /dev/null +++ b/development/_sources/CONTRIBUTING.md.txt @@ -0,0 +1,57 @@ +# Contributing + +### License + +Intel Technology Enabling For OpenShift project is licensed under the terms in [Apache-2.0](LICENSE.txt). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms. + +### Sign your work + +Please use the sign-off line at the end of the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify +the below (from [developercertificate.org](http://developercertificate.org/)): + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +660 York Street, Suite 102, +San Francisco, CA 94110 USA + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +Then you just add a line to every git commit message: + + Signed-off-by: Joe Smith + +Use your real name (sorry, no pseudonyms or anonymous contributions.) + +If you set your `user.name` and `user.email` git configs, you can sign your +commit automatically with `git commit -s`. diff --git a/development/_sources/README.md.txt b/development/_sources/README.md.txt new file mode 100644 index 00000000..e87c46aa --- /dev/null +++ b/development/_sources/README.md.txt @@ -0,0 +1,89 @@ +# Intel® Technology Enabling for OpenShift* +## Overview +The Intel Technology Enabling for OpenShift project provides Intel Data Center hardware feature-provisioning technologies with the [Red Hat OpenShift Container Platform (RHOCP)](https://www.redhat.com/en/technologies/cloud-computing/openshift/container-platform). The technology to deploy and manage the End-to-End (E2E) solutions as well as the related reference workloads for these features are also included in the project. + +These Intel Data Center hardware features currently include: +- **Intel® Software Guard Extensions (Intel® SGX)** +- **Intel® Data Center GPU Flex Series** +- **Intel® Data Center GPU Max Series** +- **Intel® QuickAssist Technology (Intel® QAT)** + +The following features will be included in future releases. +- Intel® Data Streaming Accelerator (Intel® DSA) +- Intel® In-Memory Analytics Accelerator (Intel® IAA) +- Intel® FPGA N6000 + +See details about [Supported Intel Hardware features](/docs/supported_platforms.md#supported-intel-hardware-features) and [Supported RHOCP Versions](/docs/supported_platforms.md#supported-rhocp-versions). + +For detailed information about releases, please refer [Release Information](/docs/releases.rst). + +Figure-1 is the [Architecture and Working Scope](https://github.com/intel/intel-technology-enabling-for-openshift/wiki/Intel-Technology-Enabling-for-OpenShift-Architecture-and-Working-Scope) of the project + +![Alt text](/docs/images/Intel-Technology-Enabling-for-OpenShift-Architecture.png) + +
+ Figure-1 Intel Technology Enabling for OpenShift Architecture +
+ + +## Supported platforms + +This [section](/docs/supported_platforms.md) describes the RHOCP infrastructure and Intel hardware features supported by this project. The project lifecycle and support channels can also be found [here](docs/supported_platforms.md#support). + +## Getting started +See reference [BIOS Configuration](/docs/supported_platforms.md#bios-configuration) required for each feature. +### Provisioning RHOCP cluster +Use one of these two options to provision an RHOCP cluster: +- Use the methods introduced in [RHOCP documentation](https://docs.openshift.com/container-platform/4.14/installing/index.html). +- Use [Distributed CI](https://doc.distributed-ci.io/) as we do in this project. + +In this project, we provisioned RHOCP 4.14 on a bare-metal multi-node cluster. For details about the supported RHOCP infrastructure, see the [Supported Platforms](/docs/supported_platforms.md) page. + +### Provisioning Intel hardware features on RHOCP +Please follow the steps below to provision the hardware features +1. Setting up [Node Feature Discovery](/nfd/README.md) +2. Setting up [Machine Configuration](/machine_configuration/README.md) +3. Setting up [Out of Tree Drivers](/kmmo/README.md) +4. Setting up [Device Plugins](/device_plugins/README.md) + +### Verifying hardware feature provisioning +You can use the instructions in the [link](/tests/l2/README.md) to verify the hardware features provisioning. + +## Upgrade (To be added) + +## Reference end-to-end solution +The reference end-to-end solution is based on Intel hardware feature provisioning provided by this project. + +[Intel AI Inferencing Solution](/e2e/inference/README.md) with [OpenVINO](https://github.com/openvinotoolkit/openvino) and [RHOAI](https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-data-science) + +## Reference workloads +Here are some reference workloads built on the end-to-end solution and Intel hardware feature provisioning in this project. +- Large Language Model (To be added) +- Open Federated Learning (To be added) + +## Advanced Guide +This section discusses architecture and other technical details that go beyond getting started. +- [Architecture and Working Scope](https://github.com/intel/intel-technology-enabling-for-openshift/wiki/Intel-Technology-Enabling-for-OpenShift-Architecture-and-Working-Scope) + +## Release Notes +Check the [link](https://github.com/intel/intel-technology-enabling-for-openshift/releases/) for the Release Notes. + +## Support +If users encounter any issues or have questions regarding Intel Technology Enabling for OpenShift, we recommend them to seek support through the following channels: +### Commercial support from Red Hat +This project relies on features developed and released with the latest RHOCP release. Commercial RHOCP release support is outlined in the [Red Hat OpenShift Container Platform Life Cycle Policy](https://access.redhat.com/support/policy/updates/openshift) and Intel collaborates with Red Hat to address specific requirements from our users. + +#### Open-Source Community Support +Intel Technology Enabling for OpenShift is run as an open-source project on GitHub. Project GitHub [issues](https://github.com/intel/intel-technology-enabling-for-openshift/issues) can be used as the primary support interface for users to submit feature requests and report issues to the community when using Intel technology provided by this project. Please provide detailed information about your issue and steps to reproduce it, if possible. + +## Contribute +See [CONTRIBUTING](CONTRIBUTING.md) for more information. + +## Security +To report a potential security vulnerability, please refer to [security.md](/security.md) file. + +## License +Distributed under the open source license. See [LICENSE](/LICENSE.txt) for more information. + +## Code of Conduct +Intel has adopted the Contributor Covenant as the Code of Conduct for all of its open source projects. See [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/Markdown-3.6.dist-info/LICENSE.md.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/Markdown-3.6.dist-info/LICENSE.md.txt new file mode 100644 index 00000000..6249d60c --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/Markdown-3.6.dist-info/LICENSE.md.txt @@ -0,0 +1,30 @@ +BSD 3-Clause License + +Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) +Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) +Copyright 2004 Manfred Stienstra (the original version) + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/MarkupSafe-2.1.5.dist-info/LICENSE.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/MarkupSafe-2.1.5.dist-info/LICENSE.rst.txt new file mode 100644 index 00000000..9d227a0c --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/MarkupSafe-2.1.5.dist-info/LICENSE.rst.txt @@ -0,0 +1,28 @@ +Copyright 2010 Pallets + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/README.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/README.rst.txt new file mode 100644 index 00000000..741f2ad9 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/README.rst.txt @@ -0,0 +1 @@ +This is a dummy package designed to prevent namesquatting on PyPI. You should install `beautifulsoup4 `_ instead. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/alabaster-0.7.16.dist-info/LICENSE.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/alabaster-0.7.16.dist-info/LICENSE.rst.txt new file mode 100644 index 00000000..19361a71 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/alabaster-0.7.16.dist-info/LICENSE.rst.txt @@ -0,0 +1,34 @@ +Copyright (c) 2020 Jeff Forcier. + +Based on original work copyright (c) 2011 Kenneth Reitz and copyright (c) 2010 +Armin Ronacher. + +Some rights reserved. + +Redistribution and use in source and binary forms of the theme, with or +without modification, are permitted provided that the following conditions +are met: + +* Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +* The names of the contributors may not be used to endorse or + promote products derived from this software without specific + prior written permission. + +THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/idna-3.7.dist-info/LICENSE.md.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/idna-3.7.dist-info/LICENSE.md.txt new file mode 100644 index 00000000..19b6b452 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/idna-3.7.dist-info/LICENSE.md.txt @@ -0,0 +1,31 @@ +BSD 3-Clause License + +Copyright (c) 2013-2024, Kim Davies and contributors. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst.txt new file mode 100644 index 00000000..58a2394f --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst.txt @@ -0,0 +1,19 @@ +The MIT License (MIT) +---------------------------- + +Copyright © 2016 Yoshiki Shibukawa + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software +and associated documentation files (the “Software”), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT +NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/container/README.md.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/container/README.md.txt new file mode 100644 index 00000000..03868d78 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/container/README.md.txt @@ -0,0 +1,95 @@ +# markdown-it-container + +[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-container/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-container) +[![NPM version](https://img.shields.io/npm/v/markdown-it-container.svg?style=flat)](https://www.npmjs.org/package/markdown-it-container) +[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-container/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it-container?branch=master) + +> Plugin for creating block-level custom containers for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser. + +__v2.+ requires `markdown-it` v5.+, see changelog.__ + +With this plugin you can create block containers like: + +``` +::: warning +*here be dragons* +::: +``` + +.... and specify how they should be rendered. If no renderer defined, `
` with +container name class will be created: + +```html +
+here be dragons +
+``` + +Markup is the same as for [fenced code blocks](http://spec.commonmark.org/0.18/#fenced-code-blocks). +Difference is, that marker use another character and content is rendered as markdown markup. + + +## Installation + +node.js, browser: + +```bash +$ npm install markdown-it-container --save +$ bower install markdown-it-container --save +``` + + +## API + +```js +var md = require('markdown-it')() + .use(require('markdown-it-container'), name [, options]); +``` + +Params: + +- __name__ - container name (mandatory) +- __options:__ + - __validate__ - optional, function to validate tail after opening marker, should + return `true` on success. + - __render__ - optional, renderer function for opening/closing tokens. + - __marker__ - optional (`:`), character to use in delimiter. + + +## Example + +```js +var md = require('markdown-it')(); + +md.use(require('markdown-it-container'), 'spoiler', { + + validate: function(params) { + return params.trim().match(/^spoiler\s+(.*)$/); + }, + + render: function (tokens, idx) { + var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/); + + if (tokens[idx].nesting === 1) { + // opening tag + return '
' + md.utils.escapeHtml(m[1]) + '\n'; + + } else { + // closing tag + return '
\n'; + } + } +}); + +console.log(md.render('::: spoiler click me\n*content*\n:::\n')); + +// Output: +// +//
click me +//

content

+//
+``` + +## License + +[MIT](https://github.com/markdown-it/markdown-it-container/blob/master/LICENSE) diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/deflist/README.md.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/deflist/README.md.txt new file mode 100644 index 00000000..414157bc --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/deflist/README.md.txt @@ -0,0 +1,38 @@ +# markdown-it-deflist + +[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-deflist/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-deflist) +[![NPM version](https://img.shields.io/npm/v/markdown-it-deflist.svg?style=flat)](https://www.npmjs.org/package/markdown-it-deflist) +[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-deflist/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it-deflist?branch=master) + +> Definition list (`
`) tag plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser. + +__v2.+ requires `markdown-it` v5.+, see changelog.__ + +Syntax is based on [pandoc definition lists](http://johnmacfarlane.net/pandoc/README.html#definition-lists). + + +## Install + +node.js, browser: + +```bash +npm install markdown-it-deflist --save +bower install markdown-it-deflist --save +``` + +## Use + +```js +var md = require('markdown-it')() + .use(require('markdown-it-deflist')); + +md.render(/*...*/); +``` + +_Differences in browser._ If you load script directly into the page, without +package system, module will add itself globally as `window.markdownitDeflist`. + + +## License + +[MIT](https://github.com/markdown-it/markdown-it-deflist/blob/master/LICENSE) diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/texmath/README.md.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/texmath/README.md.txt new file mode 100644 index 00000000..f79f3356 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/mdit_py_plugins/texmath/README.md.txt @@ -0,0 +1,137 @@ +[![License](https://img.shields.io/github/license/goessner/markdown-it-texmath.svg)](https://github.com/goessner/markdown-it-texmath/blob/master/licence.txt) +[![npm](https://img.shields.io/npm/v/markdown-it-texmath.svg)](https://www.npmjs.com/package/markdown-it-texmath) +[![npm](https://img.shields.io/npm/dt/markdown-it-texmath.svg)](https://www.npmjs.com/package/markdown-it-texmath) + +# markdown-it-texmath + +Add TeX math equations to your Markdown documents rendered by [markdown-it](https://github.com/markdown-it/markdown-it) parser. [KaTeX](https://github.com/Khan/KaTeX) is used as a fast math renderer. + +## Features +Simplify the process of authoring markdown documents containing math formulas. +This extension is a comfortable tool for scientists, engineers and students with markdown as their first choice document format. + +* Macro support +* Simple formula numbering +* Inline math with tables, lists and blockquote. +* User setting delimiters: + * `'dollars'` (default) + * inline: `$...$` + * display: `$$...$$` + * display + equation number: `$$...$$ (1)` + * `'brackets'` + * inline: `\(...\)` + * display: `\[...\]` + * display + equation number: `\[...\] (1)` + * `'gitlab'` + * inline: ``$`...`$`` + * display: `` ```math ... ``` `` + * display + equation number: `` ```math ... ``` (1)`` + * `'julia'` + * inline: `$...$` or ``` ``...`` ``` + * display: `` ```math ... ``` `` + * display + equation number: `` ```math ... ``` (1)`` + * `'kramdown'` + * inline: ``$$...$$`` + * display: `$$...$$` + * display + equation number: `$$...$$ (1)` + +## Show me + +View a [test table](https://goessner.github.io/markdown-it-texmath/index.html). + +[try it out ...](https://goessner.github.io/markdown-it-texmath/markdown-it-texmath-demo.html) + +## Use with `node.js` + +Install the extension. Verify having `markdown-it` and `katex` already installed . +``` +npm install markdown-it-texmath +``` +Use it with JavaScript. +```js +let kt = require('katex'), + tm = require('markdown-it-texmath').use(kt), + md = require('markdown-it')().use(tm,{delimiters:'dollars',macros:{"\\RR": "\\mathbb{R}"}}); + +md.render('Euler\'s identity \(e^{i\pi}+1=0\) is a beautiful formula in $\\RR 2$.') +``` + +## Use in Browser +```html + + + + + + + + + + +
+ + + +``` +## CDN + +Use following links for `texmath.js` and `texmath.css` +* `https://gitcdn.xyz/cdn/goessner/markdown-it-texmath/master/texmath.js` +* `https://gitcdn.xyz/cdn/goessner/markdown-it-texmath/master/texmath.css` + +## Dependencies + +* [`markdown-it`](https://github.com/markdown-it/markdown-it): Markdown parser done right. Fast and easy to extend. +* [`katex`](https://github.com/Khan/KaTeX): This is where credits for fast rendering TeX math in HTML go to. + +## ToDo + + nothing yet + +## FAQ + +* __`markdown-it-texmath` with React Native does not work, why ?__ + * `markdown-it-texmath` is using regular expressions with `y` [(sticky) property](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/sticky) and cannot avoid this. The use of the `y` flag in regular expressions means the plugin is not compatible with React Native (which as of now doesn't support it and throws an error `Invalid flags supplied to RegExp constructor`). + +## CHANGELOG + +### [0.6.0] on October 04, 2019 +* Add support for [Julia Markdown](https://docs.julialang.org/en/v1/stdlib/Markdown/) on [request](https://github.com/goessner/markdown-it-texmath/issues/15). + +### [0.5.5] on February 07, 2019 +* Remove [rendering bug with brackets delimiters](https://github.com/goessner/markdown-it-texmath/issues/9). + +### [0.5.4] on January 20, 2019 +* Remove pathological [bug within blockquotes](https://github.com/goessner/mdmath/issues/50). + +### [0.5.3] on November 11, 2018 +* Add support for Tex macros (https://katex.org/docs/supported.html#macros) . +* Bug with [brackets delimiters](https://github.com/goessner/markdown-it-texmath/issues/9) . + +### [0.5.2] on September 07, 2018 +* Add support for [Kramdown](https://kramdown.gettalong.org/) . + +### [0.5.0] on August 15, 2018 +* Fatal blockquote bug investigated. Implemented workaround to vscode bug, which has finally gone with vscode 1.26.0 . + +### [0.4.6] on January 05, 2018 +* Escaped underscore bug removed. + +### [0.4.5] on November 06, 2017 +* Backslash bug removed. + +### [0.4.4] on September 27, 2017 +* Modifying the `block` mode regular expression with `gitlab` delimiters, so removing the `newline` bug. + +## License + +`markdown-it-texmath` is licensed under the [MIT License](./license.txt) + + © [Stefan Gössner](https://github.com/goessner) diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/soupsieve-2.5.dist-info/licenses/LICENSE.md.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/soupsieve-2.5.dist-info/licenses/LICENSE.md.txt new file mode 100644 index 00000000..ae5fec59 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/soupsieve-2.5.dist-info/licenses/LICENSE.md.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 - 2023 Isaac Muse + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst.txt new file mode 100644 index 00000000..b7556ebf --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst.txt @@ -0,0 +1,5 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. auto{{ objtype }}:: {{ objname }} diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst.txt new file mode 100644 index 00000000..0f7d6f32 --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst.txt @@ -0,0 +1,29 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + + {% block methods %} + .. automethod:: __init__ + + {% if methods %} + .. rubric:: {{ _('Methods') }} + + .. autosummary:: + {% for item in methods %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block attributes %} + {% if attributes %} + .. rubric:: {{ _('Attributes') }} + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} diff --git a/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst.txt b/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst.txt new file mode 100644 index 00000000..e74c012f --- /dev/null +++ b/development/_sources/_work/venv/lib/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst.txt @@ -0,0 +1,60 @@ +{{ fullname | escape | underline}} + +.. automodule:: {{ fullname }} + + {% block attributes %} + {% if attributes %} + .. rubric:: {{ _('Module Attributes') }} + + .. autosummary:: + {% for item in attributes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block functions %} + {% if functions %} + .. rubric:: {{ _('Functions') }} + + .. autosummary:: + {% for item in functions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block classes %} + {% if classes %} + .. rubric:: {{ _('Classes') }} + + .. autosummary:: + {% for item in classes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block exceptions %} + {% if exceptions %} + .. rubric:: {{ _('Exceptions') }} + + .. autosummary:: + {% for item in exceptions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + +{% block modules %} +{% if modules %} +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: +{% for item in modules %} + {{ item }} +{%- endfor %} +{% endif %} +{% endblock %} diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/Markdown-3.6.dist-info/LICENSE.md.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/Markdown-3.6.dist-info/LICENSE.md.txt new file mode 100644 index 00000000..6249d60c --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/Markdown-3.6.dist-info/LICENSE.md.txt @@ -0,0 +1,30 @@ +BSD 3-Clause License + +Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) +Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) +Copyright 2004 Manfred Stienstra (the original version) + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/MarkupSafe-2.1.5.dist-info/LICENSE.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/MarkupSafe-2.1.5.dist-info/LICENSE.rst.txt new file mode 100644 index 00000000..9d227a0c --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/MarkupSafe-2.1.5.dist-info/LICENSE.rst.txt @@ -0,0 +1,28 @@ +Copyright 2010 Pallets + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/README.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/README.rst.txt new file mode 100644 index 00000000..741f2ad9 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/README.rst.txt @@ -0,0 +1 @@ +This is a dummy package designed to prevent namesquatting on PyPI. You should install `beautifulsoup4 `_ instead. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/alabaster-0.7.16.dist-info/LICENSE.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/alabaster-0.7.16.dist-info/LICENSE.rst.txt new file mode 100644 index 00000000..19361a71 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/alabaster-0.7.16.dist-info/LICENSE.rst.txt @@ -0,0 +1,34 @@ +Copyright (c) 2020 Jeff Forcier. + +Based on original work copyright (c) 2011 Kenneth Reitz and copyright (c) 2010 +Armin Ronacher. + +Some rights reserved. + +Redistribution and use in source and binary forms of the theme, with or +without modification, are permitted provided that the following conditions +are met: + +* Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +* The names of the contributors may not be used to endorse or + promote products derived from this software without specific + prior written permission. + +THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/idna-3.7.dist-info/LICENSE.md.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/idna-3.7.dist-info/LICENSE.md.txt new file mode 100644 index 00000000..19b6b452 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/idna-3.7.dist-info/LICENSE.md.txt @@ -0,0 +1,31 @@ +BSD 3-Clause License + +Copyright (c) 2013-2024, Kim Davies and contributors. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst.txt new file mode 100644 index 00000000..58a2394f --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst.txt @@ -0,0 +1,19 @@ +The MIT License (MIT) +---------------------------- + +Copyright © 2016 Yoshiki Shibukawa + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software +and associated documentation files (the “Software”), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT +NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/container/README.md.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/container/README.md.txt new file mode 100644 index 00000000..03868d78 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/container/README.md.txt @@ -0,0 +1,95 @@ +# markdown-it-container + +[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-container/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-container) +[![NPM version](https://img.shields.io/npm/v/markdown-it-container.svg?style=flat)](https://www.npmjs.org/package/markdown-it-container) +[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-container/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it-container?branch=master) + +> Plugin for creating block-level custom containers for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser. + +__v2.+ requires `markdown-it` v5.+, see changelog.__ + +With this plugin you can create block containers like: + +``` +::: warning +*here be dragons* +::: +``` + +.... and specify how they should be rendered. If no renderer defined, `
` with +container name class will be created: + +```html +
+here be dragons +
+``` + +Markup is the same as for [fenced code blocks](http://spec.commonmark.org/0.18/#fenced-code-blocks). +Difference is, that marker use another character and content is rendered as markdown markup. + + +## Installation + +node.js, browser: + +```bash +$ npm install markdown-it-container --save +$ bower install markdown-it-container --save +``` + + +## API + +```js +var md = require('markdown-it')() + .use(require('markdown-it-container'), name [, options]); +``` + +Params: + +- __name__ - container name (mandatory) +- __options:__ + - __validate__ - optional, function to validate tail after opening marker, should + return `true` on success. + - __render__ - optional, renderer function for opening/closing tokens. + - __marker__ - optional (`:`), character to use in delimiter. + + +## Example + +```js +var md = require('markdown-it')(); + +md.use(require('markdown-it-container'), 'spoiler', { + + validate: function(params) { + return params.trim().match(/^spoiler\s+(.*)$/); + }, + + render: function (tokens, idx) { + var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/); + + if (tokens[idx].nesting === 1) { + // opening tag + return '
' + md.utils.escapeHtml(m[1]) + '\n'; + + } else { + // closing tag + return '
\n'; + } + } +}); + +console.log(md.render('::: spoiler click me\n*content*\n:::\n')); + +// Output: +// +//
click me +//

content

+//
+``` + +## License + +[MIT](https://github.com/markdown-it/markdown-it-container/blob/master/LICENSE) diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/deflist/README.md.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/deflist/README.md.txt new file mode 100644 index 00000000..414157bc --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/deflist/README.md.txt @@ -0,0 +1,38 @@ +# markdown-it-deflist + +[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-deflist/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-deflist) +[![NPM version](https://img.shields.io/npm/v/markdown-it-deflist.svg?style=flat)](https://www.npmjs.org/package/markdown-it-deflist) +[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-deflist/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it-deflist?branch=master) + +> Definition list (`
`) tag plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser. + +__v2.+ requires `markdown-it` v5.+, see changelog.__ + +Syntax is based on [pandoc definition lists](http://johnmacfarlane.net/pandoc/README.html#definition-lists). + + +## Install + +node.js, browser: + +```bash +npm install markdown-it-deflist --save +bower install markdown-it-deflist --save +``` + +## Use + +```js +var md = require('markdown-it')() + .use(require('markdown-it-deflist')); + +md.render(/*...*/); +``` + +_Differences in browser._ If you load script directly into the page, without +package system, module will add itself globally as `window.markdownitDeflist`. + + +## License + +[MIT](https://github.com/markdown-it/markdown-it-deflist/blob/master/LICENSE) diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/texmath/README.md.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/texmath/README.md.txt new file mode 100644 index 00000000..f79f3356 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/mdit_py_plugins/texmath/README.md.txt @@ -0,0 +1,137 @@ +[![License](https://img.shields.io/github/license/goessner/markdown-it-texmath.svg)](https://github.com/goessner/markdown-it-texmath/blob/master/licence.txt) +[![npm](https://img.shields.io/npm/v/markdown-it-texmath.svg)](https://www.npmjs.com/package/markdown-it-texmath) +[![npm](https://img.shields.io/npm/dt/markdown-it-texmath.svg)](https://www.npmjs.com/package/markdown-it-texmath) + +# markdown-it-texmath + +Add TeX math equations to your Markdown documents rendered by [markdown-it](https://github.com/markdown-it/markdown-it) parser. [KaTeX](https://github.com/Khan/KaTeX) is used as a fast math renderer. + +## Features +Simplify the process of authoring markdown documents containing math formulas. +This extension is a comfortable tool for scientists, engineers and students with markdown as their first choice document format. + +* Macro support +* Simple formula numbering +* Inline math with tables, lists and blockquote. +* User setting delimiters: + * `'dollars'` (default) + * inline: `$...$` + * display: `$$...$$` + * display + equation number: `$$...$$ (1)` + * `'brackets'` + * inline: `\(...\)` + * display: `\[...\]` + * display + equation number: `\[...\] (1)` + * `'gitlab'` + * inline: ``$`...`$`` + * display: `` ```math ... ``` `` + * display + equation number: `` ```math ... ``` (1)`` + * `'julia'` + * inline: `$...$` or ``` ``...`` ``` + * display: `` ```math ... ``` `` + * display + equation number: `` ```math ... ``` (1)`` + * `'kramdown'` + * inline: ``$$...$$`` + * display: `$$...$$` + * display + equation number: `$$...$$ (1)` + +## Show me + +View a [test table](https://goessner.github.io/markdown-it-texmath/index.html). + +[try it out ...](https://goessner.github.io/markdown-it-texmath/markdown-it-texmath-demo.html) + +## Use with `node.js` + +Install the extension. Verify having `markdown-it` and `katex` already installed . +``` +npm install markdown-it-texmath +``` +Use it with JavaScript. +```js +let kt = require('katex'), + tm = require('markdown-it-texmath').use(kt), + md = require('markdown-it')().use(tm,{delimiters:'dollars',macros:{"\\RR": "\\mathbb{R}"}}); + +md.render('Euler\'s identity \(e^{i\pi}+1=0\) is a beautiful formula in $\\RR 2$.') +``` + +## Use in Browser +```html + + + + + + + + + + +
+ + + +``` +## CDN + +Use following links for `texmath.js` and `texmath.css` +* `https://gitcdn.xyz/cdn/goessner/markdown-it-texmath/master/texmath.js` +* `https://gitcdn.xyz/cdn/goessner/markdown-it-texmath/master/texmath.css` + +## Dependencies + +* [`markdown-it`](https://github.com/markdown-it/markdown-it): Markdown parser done right. Fast and easy to extend. +* [`katex`](https://github.com/Khan/KaTeX): This is where credits for fast rendering TeX math in HTML go to. + +## ToDo + + nothing yet + +## FAQ + +* __`markdown-it-texmath` with React Native does not work, why ?__ + * `markdown-it-texmath` is using regular expressions with `y` [(sticky) property](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/sticky) and cannot avoid this. The use of the `y` flag in regular expressions means the plugin is not compatible with React Native (which as of now doesn't support it and throws an error `Invalid flags supplied to RegExp constructor`). + +## CHANGELOG + +### [0.6.0] on October 04, 2019 +* Add support for [Julia Markdown](https://docs.julialang.org/en/v1/stdlib/Markdown/) on [request](https://github.com/goessner/markdown-it-texmath/issues/15). + +### [0.5.5] on February 07, 2019 +* Remove [rendering bug with brackets delimiters](https://github.com/goessner/markdown-it-texmath/issues/9). + +### [0.5.4] on January 20, 2019 +* Remove pathological [bug within blockquotes](https://github.com/goessner/mdmath/issues/50). + +### [0.5.3] on November 11, 2018 +* Add support for Tex macros (https://katex.org/docs/supported.html#macros) . +* Bug with [brackets delimiters](https://github.com/goessner/markdown-it-texmath/issues/9) . + +### [0.5.2] on September 07, 2018 +* Add support for [Kramdown](https://kramdown.gettalong.org/) . + +### [0.5.0] on August 15, 2018 +* Fatal blockquote bug investigated. Implemented workaround to vscode bug, which has finally gone with vscode 1.26.0 . + +### [0.4.6] on January 05, 2018 +* Escaped underscore bug removed. + +### [0.4.5] on November 06, 2017 +* Backslash bug removed. + +### [0.4.4] on September 27, 2017 +* Modifying the `block` mode regular expression with `gitlab` delimiters, so removing the `newline` bug. + +## License + +`markdown-it-texmath` is licensed under the [MIT License](./license.txt) + + © [Stefan Gössner](https://github.com/goessner) diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/soupsieve-2.5.dist-info/licenses/LICENSE.md.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/soupsieve-2.5.dist-info/licenses/LICENSE.md.txt new file mode 100644 index 00000000..ae5fec59 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/soupsieve-2.5.dist-info/licenses/LICENSE.md.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 - 2023 Isaac Muse + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst.txt new file mode 100644 index 00000000..b7556ebf --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst.txt @@ -0,0 +1,5 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. auto{{ objtype }}:: {{ objname }} diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst.txt new file mode 100644 index 00000000..0f7d6f32 --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst.txt @@ -0,0 +1,29 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + + {% block methods %} + .. automethod:: __init__ + + {% if methods %} + .. rubric:: {{ _('Methods') }} + + .. autosummary:: + {% for item in methods %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block attributes %} + {% if attributes %} + .. rubric:: {{ _('Attributes') }} + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} diff --git a/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst.txt b/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst.txt new file mode 100644 index 00000000..e74c012f --- /dev/null +++ b/development/_sources/_work/venv/lib64/python3.10/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst.txt @@ -0,0 +1,60 @@ +{{ fullname | escape | underline}} + +.. automodule:: {{ fullname }} + + {% block attributes %} + {% if attributes %} + .. rubric:: {{ _('Module Attributes') }} + + .. autosummary:: + {% for item in attributes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block functions %} + {% if functions %} + .. rubric:: {{ _('Functions') }} + + .. autosummary:: + {% for item in functions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block classes %} + {% if classes %} + .. rubric:: {{ _('Classes') }} + + .. autosummary:: + {% for item in classes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block exceptions %} + {% if exceptions %} + .. rubric:: {{ _('Exceptions') }} + + .. autosummary:: + {% for item in exceptions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + +{% block modules %} +{% if modules %} +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: +{% for item in modules %} + {{ item }} +{%- endfor %} +{% endif %} +{% endblock %} diff --git a/development/_sources/device_plugins/README.md.txt b/development/_sources/device_plugins/README.md.txt new file mode 100644 index 00000000..1c6624d5 --- /dev/null +++ b/development/_sources/device_plugins/README.md.txt @@ -0,0 +1,50 @@ +# Setting up Intel Device Plugins Operator + +## Overview +Intel Device Plugins are utilized to advertise Intel hardware features (resources) to a Red Hat OpenShift Container Platform (RHOCP) Cluster. This allows workloads running on pods deployed within the clusters to leverage these features. To handle the deployment and lifecycle of these device plugins, the [Intel Device Plugins Operator](https://catalog.redhat.com/software/container-stacks/detail/61e9f2d7b9cdd99018fc5736) is used. The Intel Device Plugins container images and operator have been officially certified and published on the [Red Hat Ecosystem Catalog](https://catalog.redhat.com/software/container-stacks/detail/61e9f2d7b9cdd99018fc5736). For more details on the upstream project, please refer to [Intel Device Plugins for Kubernetes](https://github.com/intel/intel-device-plugins-for-kubernetes). + +## Prerequisities +- Provisioned RHOCP cluster. Follow steps [here](/README.md). +- Setup Node Feature Discovery (NFD). Follow steps [here](/nfd/README.md). +- Follow the additional prerequisites for provisioning Intel® Data Center GPU: + - Setup out of tree drivers for Intel Data Center GPU provisioning. Follow the steps listed [here](/kmmo/README.md). +- Follow the additional prerequisites for provisioning Intel® QuickAssist Technology: + - Configure MCO for provisioning Intel QAT. Follow steps [here](/machine_configuration/README.md#machine-configuration-for-provisioning-intel-qat). + +## Install Intel Device Plugins Operator on Red Hat OpenShift +### Installation via web console +Follow the steps below to install Intel Device Plugins Operator using OpenShift web console: +1. In the OpenShift web console, navigate to **Operator** -> **OperatorHub**. +2. Search for **Intel Device Plugins Operator** in all items field -> Click **Install**. +### Verify Installation via web console +1. Go to **Operator** -> **Installed Operators**. +2. Verify that the status of the operator is **Succeeded**. + +### Installation via command line interface (CLI) +Apply the [install_operator.yaml](/device_plugins/install_operator.yaml) file: +``` +$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/device_plugins/install_operator.yaml +``` + +### Verify Installation via CLI +Verify that the operator controller manager pod is up and running: +``` +$ oc get pod | grep inteldeviceplugins-controller-manager + +inteldeviceplugins-controller-manager-6b8c76c867-hftqm 2/2 Running 0 17m +``` + +## Resources Provided by Intel Device Plugins +The resources are the user interface for customers to claim and consume the hardware features provided by Intel Device Plugins from the user pods. See below table for the details: + +| Feature | Resources | Description | Usage | +| ------- | --------- | ----------- | ----- | +| Intel® SGX | `sgx.intel.com/epc` | Intel SGX EPC memory for user pod to claim | [Link](https://github.com/intel/intel-technology-enabling-for-openshift/blob/64a6c86f3be25459c14ea988e892f9f5d873a8ca/tests/l2/sgx/sgx_job.yaml#L21) | +| Intel® Data Center GPU Flex Series
Intel® Data Center GPU Max Series | `gpu.intel.com/i915 ` | Intel Data Center GPU Card for user pod to claim | [Link](https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/device_plugins/deploy_gpu.md#using-intel-data-center-gpu-resource-exclusively) | +| Intel® QAT | `qat.intel.com/cy`
`qat.intel.com/dc` | `cy`: Intel QAT VFIO Virtual Function device configured for cryptography for user pod to claim
`dc`: Intel QAT VFIO Virtual Function device configured for cryptography for user pod to claim | [Link](https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/tests/l2/qat/qatlib_job.yaml#L24)
[Link](https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/tests/l2/qat/qatlib_job.yaml#L28) | + + +## Creating Intel Device Plugin custom resource (CR) +- To create an Intel SGX device plugin CR, follow this [link](/device_plugins/deploy_sgx.md). +- To create an Intel GPU device plugin CR, follow this [link](/device_plugins/deploy_gpu.md). +- To create an Intel QAT device plugin CR, follow this [link](/device_plugins/deploy_qat.md). diff --git a/development/_sources/device_plugins/deploy_gpu.md.txt b/development/_sources/device_plugins/deploy_gpu.md.txt new file mode 100644 index 00000000..9b46aff7 --- /dev/null +++ b/development/_sources/device_plugins/deploy_gpu.md.txt @@ -0,0 +1,45 @@ +# Create Intel GPU Device Plugin CR + +## Create CR via web console +1. Go to **Operator** -> **Installed Operators**. +2. Open **Intel Device Plugins Operator**. +3. Navigate to tab **Intel GPU Device Plugin**. +4. Click **Create GpuDevicePlugin** -> set correct parameters -> Click **Create**. +5. Optional: If you want to make any customizations, select YAML view and edit the details. Once you are done, click **Create**. + +## Verify via web console +1. Verify CR by checking the status of **Workloads** -> **DaemonSet** -> **intel-gpu-plugin**. +2. Now `GpuDevicePlugin` is created. + +## Create CR via CLI +Apply the CR yaml file: +``` +$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/device_plugins/gpu_device_plugin.yaml +``` + +## Verify via CLI +Verify that the device plugin CR is ready: +``` +$ oc get GpuDevicePlugin +``` +Output: +``` +NAME DESIRED READY NODE SELECTOR AGE +gpudeviceplugin-sample 1 1 {"intel.feature.node.kubernetes.io/gpu":"true"} 3m12s +``` + +# Using Intel Data Center GPU resource exclusively +In this release, we only verified and support the single Intel GPU `i915` resource dedicated to the single workload pod. To achieve this, we set `sharedDevNum: 1` and `preferredAllocationPolicy: none` as default options. +As the cluster administrator, use the [gpu_device_plugin.yaml](/device_plugins/gpu_device_plugin.yaml) provided from the previous section Create CR via CLI or use the default options from Create CR via web Console. +As the application owner, when claiming the i915 resource, make sure the resource limits and requests are set as shown below: +``` +spec: + containers: + - name: gpu-pod + resources: + limits: + gpu.intel.com/i915: 1 + requests: + gpu.intel.com/i915: 1 +``` +For more details, please refer to this [issue](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1408). \ No newline at end of file diff --git a/development/_sources/device_plugins/deploy_qat.md.txt b/development/_sources/device_plugins/deploy_qat.md.txt new file mode 100644 index 00000000..8c8378ce --- /dev/null +++ b/development/_sources/device_plugins/deploy_qat.md.txt @@ -0,0 +1,72 @@ +# Create Intel QAT Device Plugin CR + +## Create a CR via web console +1. Go to **Operator** -> **Installed Operators**. +2. Open **Intel Device Plugins Operator**. +3. Navigate to tab **Intel QuickAssist Technology Device Plugin**. +4. Click **Create QatDevicePlugin** -> set correct parameters -> Click **Create** +5. Optional: If you want to make any customizations, select YAML view and edit the details. When you are done, click **Create**. + +## Verify via web console +1. Verify CR by checking the status of **Workloads** -> **DaemonSet** -> **intel-qat-plugin**. +2. Now `QatDevicePlugin` is created. + +## Create CR via CLI +Apply the CR yaml file: +``` +$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/device_plugins/qat_device_plugin.yaml +``` + +## Verify via CLI +Verify that the device plugin CR is ready: +``` +$ oc get QatDevicePlugin +``` +Output: +``` +NAME DESIRED READY NODE SELECTOR AGE +qatdeviceplugin-sample 1 1 {"intel.feature.node.kubernetes.io/qat":"true"} 3h27m +``` + +# Verify QAT Device Plugin +After the plugin is deployed, use below command to verify QAT resources: +``` +$ oc describe node | grep qat.intel.com + qat.intel.com/cy: 32 + qat.intel.com/cy: 32 + qat.intel.com/dc: 32 + qat.intel.com/dc: 32 + ``` + +# QAT Device Plugin Configuration +> **Note**: The QAT device plugin can be configured with the flags. In this release, only the configurations in the table below are verified and supported on RHOCP. + +For more details about the QAT device plugin configuration flags, see [Modes and Configurations Options](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/cmd/qat_plugin/README.md#modes-and-configuration-options). + +| Flag | Configuration | Description | +| ---- | ---- | ---- | +| `-dpdk-driver` | vfio-pci | Using vfio-pci driver to manage QAT VFIO device. See details [here](https://doc.dpdk.org/guides/linux_gsg/linux_drivers.html) | +| `-kernel-vf-drivers` | 4xxxvf | Supporting 4xxx QAT device
**Note**: Verified on 4th Gen Intel® Xeon® Scalable processors. See details [here](https://github.com/intel/qatlib/blob/main/INSTALL#L72) | +| `-max-num-devices ` | 128 | It is the maximum VF device it can support for 4xxx QAT device. If the number exceeds the maximum number the QAT device supports, then the maximum number will be enabled. | +| `-provisioning-config ` | Name of ConfigMap | See section [QAT resource configuration](/device_plugins/deploy_qat.md#qat-resource-configuration-experimental) | + +## QAT Resource Configuration (experimental) + +**NOTE**: In this release, this is an experimental feature. The efforts to [enhance this feature](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1529) and [make it more stable](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1542) are on going. + +In this release, if the user does not configure the QAT resources through the device plugin `-provisioning-config` flag. The device plugin will configure half of the QAT VFIO VF devices for compression/decompression and the other half for cryptography. + +Users can use the steps below to customize the QAT resource configuration: +1. Create the configmap for qat resource configuration + ``` + $ oc create configmap --namespace=openshift-operators --from-literal "qat.conf=ServicesEnabled=