diff --git a/docs/_config.yml b/docs/_config.yml index 92dd0f5a..f3c44f61 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -42,15 +42,15 @@ remote_theme: rundocs/jekyll-rtd-theme@v2.0.9 # - vendor/ruby/ # Document versioning -version: master +version: v0.2 display_version_list: true # Release is the full released version number. Used to make external links to # point to the correct blobs in the Github repo. This is also the version shown # in the sidebar (top left corner of the page) -release: master +release: v0.2.0 # Container image which to point to in the documentation -container_image: gcr.io/k8s-staging-nfd/node-feature-discovery-operator:master +container_image: k8s.gcr.io/nfd/node-feature-discovery-operator:v0.2.0 # Operand Node Feature Discovery documentation version -operand_version: v0.8 +operand_version: v0.7 diff --git a/docs/advanced/nodefeaturediscovery.md b/docs/advanced/nodefeaturediscovery.md index a16e2c1b..e568f2af 100644 --- a/docs/advanced/nodefeaturediscovery.md +++ b/docs/advanced/nodefeaturediscovery.md @@ -19,116 +19,95 @@ metadata: spec: operand: namespace: node-feature-discovery-operator - image: gcr.io/k8s-staging-nfd/node-feature-discovery:master + image: k8s.gcr.io/nfd/node-feature-discovery:v0.7.0 imagePullPolicy: Always - servicePort: 12000 workerConfig: configData: | - #core: - # labelWhiteList: - # noPublish: false - # sleepInterval: 60s - # sources: [all] - # klog: - # addDirHeader: false - # alsologtostderr: false - # logBacktraceAt: - # logtostderr: true - # skipHeaders: false - # stderrthreshold: 2 - # v: 0 - # vmodule: - ## NOTE: the following options are not dynamically run-time configurable - ## and require a nfd-worker restart to take effect after being changed - # logDir: - # logFile: - # logFileMaxSize: 1800 - # skipLogHeaders: false - #sources: - # cpu: - # cpuid: - ## NOTE: whitelist has priority over blacklist - # attributeBlacklist: - # - "BMI1" - # - "BMI2" - # - "CLMUL" - # - "CMOV" - # - "CX16" - # - "ERMS" - # - "F16C" - # - "HTT" - # - "LZCNT" - # - "MMX" - # - "MMXEXT" - # - "NX" - # - "POPCNT" - # - "RDRAND" - # - "RDSEED" - # - "RDTSCP" - # - "SGX" - # - "SSE" - # - "SSE2" - # - "SSE3" - # - "SSE4.1" - # - "SSE4.2" - # - "SSSE3" - # attributeWhitelist: - # kernel: - # kconfigFile: "/path/to/kconfig" - # configOpts: - # - "NO_HZ" - # - "X86" - # - "DMI" - # pci: - # deviceClassWhitelist: - # - "0200" - # - "03" - # - "12" - # deviceLabelFields: - # - "class" - # - "vendor" - # - "device" - # - "subsystem_vendor" - # - "subsystem_device" - # usb: - # deviceClassWhitelist: - # - "0e" - # - "ef" - # - "fe" - # - "ff" - # deviceLabelFields: - # - "class" - # - "vendor" - # - "device" - # custom: - # - name: "my.kernel.feature" - # matchOn: - # - loadedKMod: ["example_kmod1", "example_kmod2"] - # - name: "my.pci.feature" - # matchOn: - # - pciId: - # class: ["0200"] - # vendor: ["15b3"] - # device: ["1014", "1017"] - # - pciId : - # vendor: ["8086"] - # device: ["1000", "1100"] - # - name: "my.usb.feature" - # matchOn: - # - usbId: - # class: ["ff"] - # vendor: ["03e7"] - # device: ["2485"] - # - usbId: - # class: ["fe"] - # vendor: ["1a6e"] - # device: ["089a"] - # - name: "my.combined.feature" - # matchOn: - # - pciId: - # vendor: ["15b3"] - # device: ["1014", "1017"] - # loadedKMod : ["vendor_kmod1", "vendor_kmod2"] + #sources: + # cpu: + # cpuid: + ## NOTE: whitelist has priority over blacklist + # attributeBlacklist: + # - "BMI1" + # - "BMI2" + # - "CLMUL" + # - "CMOV" + # - "CX16" + # - "ERMS" + # - "F16C" + # - "HTT" + # - "LZCNT" + # - "MMX" + # - "MMXEXT" + # - "NX" + # - "POPCNT" + # - "RDRAND" + # - "RDSEED" + # - "RDTSCP" + # - "SGX" + # - "SSE" + # - "SSE2" + # - "SSE3" + # - "SSE4.1" + # - "SSE4.2" + # - "SSSE3" + # attributeWhitelist: + # kernel: + # kconfigFile: "/path/to/kconfig" + # configOpts: + # - "NO_HZ" + # - "X86" + # - "DMI" + # pci: + # deviceClassWhitelist: + # - "0200" + # - "03" + # - "12" + # deviceLabelFields: + # - "class" + # - "vendor" + # - "device" + # - "subsystem_vendor" + # - "subsystem_device" + # usb: + # deviceClassWhitelist: + # - "0e" + # - "ef" + # - "fe" + # - "ff" + # deviceLabelFields: + # - "class" + # - "vendor" + # - "device" + # custom: + # - name: "my.kernel.feature" + # matchOn: + # - loadedKMod: ["example_kmod1", "example_kmod2"] + # - name: "my.pci.feature" + # matchOn: + # - pciId: + # class: ["0200"] + # vendor: ["15b3"] + # device: ["1014", "1017"] + # - pciId : + # vendor: ["8086"] + # device: ["1000", "1100"] + # - name: "my.usb.feature" + # matchOn: + # - usbId: + # class: ["ff"] + # vendor: ["03e7"] + # device: ["2485"] + # - usbId: + # class: ["fe"] + # vendor: ["1a6e"] + # device: ["089a"] + # - name: "my.combined.feature" + # matchOn: + # - pciId: + # vendor: ["15b3"] + # device: ["1014", "1017"] + # loadedKMod : ["vendor_kmod1", "vendor_kmod2"] ``` For more information about how to setup the `WorkerConfig` stanza,