Commit Graph

33 Commits

Author SHA1 Message Date
Hyeongju Johannes Lee
b3459a4d17 operator: fix outdated information
update documentation in DEVEL.md too

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2025-03-13 14:42:00 +02:00
Hyeongju Johannes Lee
696877af03 e2e: add compress-perf
still maintain ci/cd skip test for compress-perf

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2024-05-13 17:57:55 +03:00
Hyeongju Johannes Lee
2af37fd4cb qat_dpdk_app: drop generic
Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2024-05-07 20:46:12 +03:00
Hyeongju Johannes Lee
5347665895 doc: update DEVEL.md for e2e tests
Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2023-09-21 13:13:06 -07:00
Mikko Ylinen
834f598f80 deployments: update to NFD v0.14.1 and drop custom GPU deployment
With the NFD recent versions (v0.13+), it's no longer necessary to
start NFD with custom nfd-master args/rbac settings to get numeric
labels registered as extended resources.

The same can be specified via NodeFeatureRules which also works for
"local" source with feature files.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2023-09-20 14:02:52 +03:00
Hyeongju Johannes Lee
6a60c745d2 operator: add image upgrade with env vars
Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2023-09-18 11:45:52 -07:00
Hyeongju Johannes Lee
4b9e86c2b7 DEVEL.md: update document for publishing to operatorhub
Improve the readability of fields to be checked in the CSV
Remove leftovers from using packagemanifests
Fix link in the table
Fix the typo of a git command option -S to -s
Add punctuations to sentences
Make registry part look a part of the process of publishing

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2022-11-11 17:21:08 +02:00
Hyeongju Johannes Lee
92239362ac Makefile: remove unnecessary variable for operator
Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2022-11-11 17:21:07 +02:00
Hyeongju Johannes Lee
f85fbd6848 operator: fix the operator image name and update docs in DEVEL.md
https://sdk.operatorframework.io/docs/cli/operator-sdk_run_bundle/
According to the documentation of operator-sdk, docker.io should
be speficied.

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2022-11-11 17:04:37 +02:00
Mikko Ylinen
2b2892eb09 build: add BUILDER=podman
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-09-13 18:02:45 +03:00
Mikko Ylinen
307e960871 docs: fix remaining review comments
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-09-06 14:28:25 +03:00
Mikko Ylinen
1b3accacc2 docs: rework development guide
Currently, each individual plugin README documents roughly the same
daily development steps to git clone, build, and deploy. Re-purpose
the plugin READMEs more towards cluster admin type of documentation
and start moving all development related documentation to DEVEL.md.

The same is true for e2e testing documentation which is scattered
in places where they don't belong to. Having all day-to-day
development Howtos is good to have in a centralized place.

Finally, the cleanup includes some harmonization to plugins'
table of contents which now follows the pattern:

* [Introduction](#introduction)
(* [Modes and Configuration Options](#modes-and-configuration-options))
* [Installation](#installation)
    (* [Prerequisites](#prerequisites))
    * [Pre-built Images](#pre-built-images)
    * [Verify Plugin Registration](#verify-plugin-registration)
* [Testing and Demos](#testing-and-demos)
    * ...

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-08-31 20:00:15 +03:00
Hyeongju Johannes Lee
e5644d7645 operator: update doc for publishing 2022-06-07 13:49:24 +03:00
Ukri Niemimuukko
30d5a2a13b Allow usage of pre-created licenses and generate dockerfiles
As a build optimization, allow usage of pre-created licenses.
Together with usage of go mod vendor, the container build
times are significantly shorter.

Dockerfiles are generated from include-snippets on the fly.

Signed-off-by: Ukri Niemimuukko <ukri.niemimuukko@intel.com>
2022-05-30 19:36:24 +03:00
Hyeongju Johannes Lee
5a54b3362d operator deployment: move from packagemanifests to bundle
Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2022-04-25 19:01:52 +03:00
Hyeongju Johannes Lee
facd7b8855 doc: fix operatorhub publishing instruction
There was a mistake in #842 that git clone command didn't come up
together with the command cp -r. In addition, this commit includes
the changes following the suggestion made after #842 was merged.

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2022-01-12 16:19:04 +02:00
Hyeongju Johannes Lee
a22643b4ab doc: fix operatorhub publishing instruction
Current instruction does not work properly.
operator-sdk run packagemanifests should run with the manifests of the
previous version.

Signed-off-by: Hyeongju Johannes Lee <hyeongju.lee@intel.com>
2022-01-10 20:28:24 +02:00
Ed Bartosh
c4483f4f06 add 3 tags to the base operator manifest
- containerImage is required by the comunity-operators PR checks
- repository and createdAt are shown on the operator page:
  https://operatorhub.io/operator/intel-device-plugins-operator

Signed-off-by: Ed Bartosh <eduard.bartosh@intel.com>
2021-08-19 17:15:42 +03:00
Ed Bartosh
95bbc1049f update operatol publishing guide
- updated community operators urls
- added more details

Signed-off-by: Ed Bartosh <eduard.bartosh@intel.com>
2021-08-19 13:31:50 +03:00
Ukri Niemimuukko
518fb93461 optional Allocator interface
This adds a new optional Allocator interface which allows the
plugins to implement the whole Allocate functionality.

Signed-off-by: Ukri Niemimuukko <ukri.niemimuukko@intel.com>
Signed-off-by: Dmitry Rozhkov <dmitry.rozhkov@intel.com>
2021-06-04 13:06:27 +03:00
Mikko Ylinen
97bcecda04 operator: update usage guidelines
As the operator container image is available from a registry, we should
guide users to use it rather than build and deploy it locally.

Further, drop (un)deploy-operator targets in favor of simply using
kubectl for deployment.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2021-03-30 15:33:09 +03:00
Mikko Ylinen
19e5666937 doc: add checklist for new device plugins
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2021-02-24 13:08:10 +02:00
Mikko Ylinen
e94857ce5d docs: harmonize device plugins operator naming
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2021-02-04 15:12:37 +02:00
Dmitry Rozhkov
f0fa9df292 operator: prepare for publishing at operatorhub.io 2020-11-24 18:35:56 +02:00
Kevin Putnam
1d149ffee6 Documentation: Fixes broken links and standardizes headers.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-09-22 08:32:21 -07:00
Dmitry Rozhkov
1b82ab9df6 sync README.md files with the current state of the code
Closes #356
2020-09-16 10:54:39 +03:00
Dmitry Rozhkov
a62c6f7d5e fpga webhook: reimplement to use kubebuilder framework
Simplify upgrade procedure to newer versions of kubernetes by relying on the
kubebuilder framework rather than using codegen directly.

Closes #377
2020-08-17 12:09:03 +03:00
Dmitry Rozhkov
c63dbf61b8 fpgawebhook: move to v2 API of fpga.intel.com group 2020-05-04 15:43:20 +03:00
Dmitry Rozhkov
8fc187f4d8 move to k8s v1.18.2 release
Also fix the plugins and e2e tests
2020-04-17 12:40:18 +03:00
Graham Whaley
71d08224ee fpga: move to using klog for logs and debug
Move all the fpga components to using klog for logging
and debug. This includes replacing our homebrew 'fatal()'
with klog.Error().

Modify the deployment files to move from `-debug` to
`-v`, and set their default level to '1' (Info), rather
than full debug mode ('4').

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-03-24 14:31:53 +00:00
Graham Whaley
f8dbc896a1 devicemanager: qat: use klog for logging and debug
Move the framework, and the qat driver, to use `klog`
for logging and debug.

This has a some noticeable effects:

1) Our default log output gains a bunch of annotation:
From:
    QAT device plugin started in 'dpdk' mode
To:
    I0312 11:51:02.057728    6053 qat_plugin.go:64] QAT device plugin started in 'dpdk' mode

(there is now a command line option to drop those annotations if
necessary).

2) We gain a bunch of command line parameters from klog for controlling log
levels and output. We go from 5 arguments to 17:

---
Usage of ./cmd/qat_plugin/qat_plugin:
  -add_dir_header
        If true, adds the file directory to the header
  -alsologtostderr
        log to standard error as well as files
  -debug
        enable debug output
  -dpdk-driver string
        DPDK Device driver for configuring the QAT device (default "vfio-pci")
  -kernel-vf-drivers string
        Comma separated VF Device Driver of the QuickAssist Devices in the system. Devices supported: DH895xCC,C62x,C3xxx and D15xx (default "dh895xccvf,c6xxvf,c3xxxvf,d15xxvf")
  -log_backtrace_at value
        when logging hits line file:N, emit a stack trace
  -log_dir string
        If non-empty, write log files in this directory
  -log_file string
        If non-empty, use this log file
  -log_file_max_size uint
        Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
  -logtostderr
        log to standard error instead of files (default true)
  -max-num-devices int
        maximum number of QAT devices to be provided to the QuickAssist device plugin (default 32)
  -mode string
        plugin mode which can be either dpdk (default) or kernel (default "dpdk")
  -skip_headers
        If true, avoid header prefixes in the log messages
  -skip_log_headers
        If true, avoid headers when opening log files
  -stderrthreshold value
        logs at or above this threshold go to stderr (default 2)
  -v value
        number for the log level verbosity
  -vmodule value
        comma-separated list of pattern=N settings for file-filtered logging
---

3) Our `-debug` flag is now replaced by the `klog` `-v n` flag.

*NOTE:* This is potentially a minor breaking change. Applying
this debug overlay to any previous (pre-klog edit) images will
cause the container to fail to launch, as it will not recognise
the new `-v` arguments.

We also update the kustomize deployment to move from using
DEBUG env vars to adding a VERBOSITY var that controls both
the log verbosity and now the debug mode enabling.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2020-03-19 11:20:48 +00:00
MCamp859
5e9afb3443 Minor text edits to devel.md.
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-02-13 09:36:33 -05:00
Dmitry Rozhkov
92f6a547cb Add doc on how to develop new device plugins 2019-02-06 09:56:51 +02:00