From f76fdb04c9f86c98259ef6df07fa807fa42973bd Mon Sep 17 00:00:00 2001 From: Matt Elliott Date: Fri, 13 Dec 2024 12:26:46 -0500 Subject: [PATCH] Spell check configuration, fixed formatting errors (#28) * Spelling and formatting fixes * spellcheck configuration with updated rules to ignore common Kubernetes terms * Update spellcheck config filename --- .spellcheck.yml | 206 ++++++++++++++++++++++++ .wordlist.txt | 54 +++++++ docs/metrics/exporter.md | 6 +- docs/specialized_networks/http-proxy.md | 2 +- 4 files changed, 262 insertions(+), 6 deletions(-) create mode 100644 .spellcheck.yml create mode 100644 .wordlist.txt diff --git a/.spellcheck.yml b/.spellcheck.yml new file mode 100644 index 0000000..a1bfbc2 --- /dev/null +++ b/.spellcheck.yml @@ -0,0 +1,206 @@ +# BSD 3-Clause License +# +# Copyright (c) 2017-2022, Pytorch contributors +# All rights reserved. +# Modifications Copyright (c) 2023, Advanced Micro Devices, Inc. +# All rights reserved. +# +# Redistribution and use in source and binary forms, 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. +# +# * 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. + +matrix: +- name: Markdown + sources: + - ['docs/**/*.md', '!docs/doxygen/mainpage.md'] + - ['tools/autotag/templates/**/*.md', '!tools/autotag/templates/**/5*.md', '!tools/autotag/templates/**/6.0*.md', '!tools/autotag/templates/**/6.1*.md'] + expect_match: false + aspell: + lang: en + dictionary: + wordlists: + - .wordlist.txt + pipeline: + - pyspelling.filters.context: + context_visible_first: true + delimiters: + # Manual disabling via: #spellcheck-disable + - open : '^ *$' + content: '[\s\S]*?' + close: '^ *$' + # Ignore URLs in [text](URL) + - open : '\[[^]]*?]\(' + content: '[^)]*?' + close: '\)' + # Ignore out-of-line URL references in [text][reference-name] + - open : '\[[^\]]*?\]\[' + content: '[^\]]*?' + close: '\]' + # Ignore out-of-line URL definitions + - open : '^ {0,3}\[[^\]]*?\]:\s*\S+' + close: '$' + # Ignore URLs in + - open : '\<' + content: '[^]]*?' + close: '\>' + # Ignore text in backtick code blocks. + - open : '(?s)^(?P *`{3,})[^\n]*$' + close: '^(?P=open)$' + # Ignore text between inline back ticks + - open : '(?P`+)' + content: '[^\n]+' + close: '(?P=open)' + # Ignore block classes and extra in :::{class} extra + - open : '^ *:{3,}' + content: '[^\n]+' + close: '' + # Ignore keys in :property: key + - open : '^ *:[^\n:]*: +' + content: '[^\n]+' + close: '$' + # Ignore properties in :property: + - open : '^ *:' + close: ':' + # Ignore tag in (tag)= + - open : '(' + content: '[^\n]+' + close: ')=$' + # Ignore hyphenated technical terms like amd-smi + - open: '\b[a-zA-Z]+-[a-zA-Z-]+\b' + close: '' + # Ignore command patterns like kubectl apply -f + - open: '\b[a-zA-Z-]+\s+[a-zA-Z-]+\s+-[a-zA-Z]\b' + close: '' + # Ignore CLI flags and their values + - open: '--[a-zA-Z-]+=?' + content: '[^\s]*' + close: '\s' + # Ignore file extensions + - open: '\.[a-zA-Z0-9]+\b' + content: '' + close: '' + # Ignore k8s resource names + - open: '\b[a-z-]+\.(yaml|json|conf)\b' + close: '' + # Configuration keys and values + - open: '^\s*[a-zA-Z]+[a-zA-Z0-9]*:' + content: '.*' + close: '$' + - open: '[a-zA-Z]+[a-zA-Z0-9]*=[^\s]*' + close: '' + # Handle all variations of config keys (camelCase, lowercase, etc) + - open: '\b[a-z]+[a-zA-Z0-9]*(?:[A-Z][a-z0-9]+)*\b' + close: '' + - pyspelling.filters.url: +- name: reST + sources: + - 'docs/**/*.rst' + expect_match: false + aspell: + lang: en + dictionary: + wordlists: + - .wordlist.txt + pipeline: + - pyspelling.filters.text: + - pyspelling.filters.context: + context_visible_first: true + delimiters: + # Ignore possessive endings + - open: '(?<=\w)''s(?!\w)' + close: '\b' + # Ignore text between inline back ticks + - open: '(div style|iframe).*' + close: '\n' + - open: '(- )?(?P`+)' + close: '(?P=open)' + # Ignore reStructuredText roles + - open: ':(?:(class|file|func|math|ref|octicon|meth|obj)):`' + content: '[^`]*' + close: '`' + - open: ':width:' + close: '$' + # Exclude raw directive + - open: '\.\. (raw|grid-item-card|galleryitem|includenodoc)::.*$\n*' + close: '\n' + # Ignore reStructuredText literals + - open: '::$' + close: '(?P(?:((?P[ ]+).*$)|(\n))+)' + # Ignore reStructuredText hyperlinks + - open: '\s' + content: '\w*' + close: '_' + # Ignore reStructuredText header --- + - open: '^' + content: '--*' + close: '$' + # Ignore reStructuredText header ''' + - open: '^' + content: '''''*' + close: '$' + # Ignore reStructuredText block directives + - open: '\.\. (code-block|math|csv-table)::.*$\n*' + content: '(?P(^(?P[ ]+).*$\n))(?P(^([ \t]+.*|[ \t]*)$\n)*)' + close: '(^(?![ \t]+.*$))' + - open: '\.\. (raw)::.*$\n*' + close: '^\s*$' + # Ignore reStructuredText substitution definitions + - open: '^\.\. \|[^|]+\|' + close: '$' + # Ignore reStructuredText substitutions + - open: '\|' + content: '[^|]*' + close: '\|_?' + # Ignore reStructuredText toctree + - open: '\.\.\s+toctree::' + close: '(?P(?:((?P[ ]+).*$)|(\n))+)' + # Ignore directives + - open: '\.\.\s+(figure|image|include|only|tabularcolumns|datatemplate:nodata)::' + close: '$' + # Ignore reStructuredText reference + - open: '^.{2}[ ]+_' + close: '$' + # Ignore doxygen directives + - open: '\.\. (autodoxygenindex|doxygenfunction|doxygenstruct|doxygenclass|doxygennamespace|doxygenconcept|doxygenenum|doxygenenumvalue|doxygentypedef|doxygenunion|doxygendefine|doxygenvariable|doxygenfile|doxygengroup|autodoxygenfile|doxygenpage)::.*$\n*' + content: '(?P(^(?P[ ]+).*$\n))(?P(^([ \t]+.*|[ \t]*)$\n)*)' + close: '(^(?![ \t]+.*$))' + # Ignore doxygen one line directives + - open: '\.\. (autodoxygenindex|doxygenfunction|doxygenstruct|doxygenclass|doxygennamespace|doxygenconcept|doxygenenum|doxygenenumvalue|doxygentypedef|doxygenunion|doxygendefine|doxygenvariable|doxygenfile|doxygengroup|autodoxygenfile|doxygenpage)::' + content: '[ \S]*' + close: '\n' + # Manual disabling via: #spellcheck-disable + - open : '^.. $' + content: '[\s\S]*?' + close: '^.. $' + # Ignore hyphenated technical terms like amd-smi + - open: '\b[a-zA-Z]+-[a-zA-Z-]+\b' + close: '' + # Ignore command patterns like kubectl apply -f + - open: '\b[a-zA-Z-]+\s+[a-zA-Z-]+\s+-[a-zA-Z]\b' + close: '' + # Ignore CLI flags and their values + - open: '--[a-zA-Z-]+=?' + content: '[^\s]*' + close: '\s' + - pyspelling.filters.url: diff --git a/.wordlist.txt b/.wordlist.txt new file mode 100644 index 0000000..6a3f3ef --- /dev/null +++ b/.wordlist.txt @@ -0,0 +1,54 @@ +CLI +CNI +DKMS +DNS +DockerHub +GPUs +HTTPS +KMM +MOK +NFD +OLM +PCI +RBAC +ROCm +TLS +YAML +allocatable +bool +calico +clusterIP +config +configmap +cryptographic +daemonset +DeviceConfig +Dockerfile +flannel +hostname +hostnames +json +kaniko +Kubernetes +kubeconfig +labeller +lifecycle +modprobe +namespace +NodePort +NotReady +plugin +PreFlight +prometheus +quay +rocminfo +runtime +schedulable +systemd +ubuntu +unschedulable +validation +verison +webhook +CRD +uninstallation diff --git a/docs/metrics/exporter.md b/docs/metrics/exporter.md index d0d97a8..905f220 100644 --- a/docs/metrics/exporter.md +++ b/docs/metrics/exporter.md @@ -9,16 +9,12 @@ configure ``` enable ``` field in deviceconfig Custom Resource(CR) to enable/dis metricsExporter: # To enable/disable the metrics exporter, disabled by default enable: True - # kubernetes service type for metrics exporter, clusterIP(default) or NodePort serviceType: "NodePort" - # Node port for metrics exporter service, metrics endpoint $node-ip:$nodePort nodePort: 32500 - # image for the metrics-exporter container image: "amd/device-metrics-exporter/exporter:v1" - ``` **metrics-exporter** pods start after updating the **DeviceConfig** CR @@ -33,7 +29,7 @@ test-deviceconfig-metrics-exporter-q8hbb 1/1 Running 0 74s |----------------------------|----------------------------------------------| | **Enable** | Enable/Disable metrics exporter | | **Port** | Service port exposed by metrics exporter | -| **serviceType** | service type for metrics, clusterIP/Nodeport | +| **serviceType** | service type for metrics, clusterIP/NodePort | | **nodePort** | Node port for metrics exporter service | | **selector** | Node selector for metrics exporter daemonset | | **image** | metrics exporter image | diff --git a/docs/specialized_networks/http-proxy.md b/docs/specialized_networks/http-proxy.md index 7c29bf5..b00bb80 100644 --- a/docs/specialized_networks/http-proxy.md +++ b/docs/specialized_networks/http-proxy.md @@ -11,7 +11,7 @@ Downloading the driver installer (Step 2) can be skipped when using a [pre-compi When users setting up a Kubernetes cluster with traffic redirected to a proxy server, ensure the Kubernetes nodes, container runtime, and GPU Operator pods are properly configured to apply the proxy network settings. -This document won't cover all the detailed steps about how to setup proxy network, configure OS level proxy configurationa and update the container runtime level networking settings, since those steps are not specific to the AMD GPU Operator. The rest of the document will show users the methods to inject the proxy configuration to AMD GPU Operator so that all the components images and driver installer can be downloaded successfully behind a HTTP proxy. +This document won't cover all the detailed steps about how to setup proxy network, configure OS level proxy configuration and update the container runtime level networking settings, since those steps are not specific to the AMD GPU Operator. The rest of the document will show users the methods to inject the proxy configuration to AMD GPU Operator so that all the components images and driver installer can be downloaded successfully behind a HTTP proxy. ## Configuration Options