1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Commit graph

503 commits

Author SHA1 Message Date
Kubernetes Prow Robot
a43334df5c
Merge pull request #378 from mythi/fix-pages
README: fix link to Github pages
2020-10-30 05:18:06 -07:00
Mikko Ylinen
1ca8b6c34d README: fix link to Github pages
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-10-30 13:37:50 +02:00
Kubernetes Prow Robot
21aace2e4e
Merge pull request #375 from marquiz/documentation/theme-sync
docs: sync navbar from jekyll-rdt-theme v2.0.9
2020-10-29 13:48:06 -07:00
Markus Lehtonen
e036d26953 docs: update the navbar versions menu
Make it hidden, by default. Unify style with other items in the navbar
(making version list horizontal, for example). Show current version next
to the caret mark that opens the menu.
2020-10-29 22:32:25 +02:00
Markus Lehtonen
82f5c89e1a docs: sync navbar from jekyll-rdt-theme v2.0.9 2020-10-29 22:27:42 +02:00
Kubernetes Prow Robot
12b6812456
Merge pull request #371 from marquiz/documentation/dynamic-version-menu
docs: make the list of available versions dynamic
2020-10-29 13:08:07 -07:00
Kubernetes Prow Robot
edebe815c9
Merge pull request #368 from marquiz/devel/gh-pages
Migrate documentation from README to docs/
2020-10-29 12:18:06 -07:00
Markus Lehtonen
f6669e7d66 docs: add todo/placeholder pages under advanced
Placeholders for content that will be added in the future. Do not
publish these virtually empty pages.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
fb106558e8 docs: instructions for uninstallation and operator usage
Describe NFD deployment via the operator.

Add minimal documentation for uninnstalling NFD. Add instructions and
template spec for running "nfd-master --prune".  Also modify the RBAC
rules in nfd-master spec template to make it possible doing --prune
(allow nfd-master to list nodes in the cluster).
2020-10-29 14:08:16 +02:00
Markus Lehtonen
409ad01a1c docs: describe deployment using templates
Use the existing content as a base but with heave editing. Move local
examples involving make to the developers guide.

Drop the really hackish label-nodes.sh. Just replace it with command
line examples in the documentation. If somebody really is dying for this
write it from scratch and put under scripts/hack.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
0c276b6298 docs: add instructions for working on documentation 2020-10-29 14:08:16 +02:00
Markus Lehtonen
6c0d6c9003 docs: add commandline references for nfd-master and nfd-worker 2020-10-29 14:08:16 +02:00
Markus Lehtonen
2469db839f docs: markdown style fixes
Fix markdown syntax and style for content that was moved from README.md
to docs/:
- get-started/introduction
- examples-and-demos
- get-started/features
- contributing

Unify the spelling of master and worker in headings and beginning of
senctences.

Also, env variable for container name in developers-guide.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
a9d45c80ac README: move content over to docs/
Move all content from README.md to the Jekyll site under docs/. Also
re-organize it into multiple sub-pages.

Populate README with fresh content turning it into virtually a big link
to the html-based documentation site. Spiced up with super-quick-start
instructions.
2020-10-29 14:07:08 +02:00
Markus Lehtonen
2215cfa7c6 docs: add landing page and quick-start guide 2020-10-29 13:29:10 +02:00
Markus Lehtonen
c05c6f2e5b docs: make the list of available versions dynamic
Make the list of available versions dynamic. The items displayed is now
generated with javascript. The parent directory of the site is supposed
to contain versions.js providing getVersionListItems() that returns the
available versions.

The update-gh-pages.sh script is modified to update/create versions.js
on every invocation. It simply lists all directories in the root
directory and adds them to the version list.
2020-10-22 21:44:49 +03:00
Markus Lehtonen
502a8c83a9 update-gh-pages.sh: create 'stable' symlink
Create/update a symlink to the documentation of the latest released
version (if one exists).
2020-10-22 21:44:49 +03:00
Kubernetes Prow Robot
a08fb66fa7
Merge pull request #373 from marquiz/fixes/prow-gh-pages
scripts: fix gh-pages build failure in prow
2020-10-22 11:39:37 -07:00
Markus Lehtonen
194f42f5c9 docs: pin version of jekyll-rtd-theme
Sync our customizations under _includes/ with v2.0.9 of
jekyll-rtd-theme. Also, pin the theme version in order to avoid abrupt
build failures in the future (caused by our customization becoming
incompatible with the rolling latest version).

Also, drop jekyll-rtd-theme from the Gemfile. It's useless there as it's
being mandated by remote-theme setting in _config.yml.
2020-10-22 21:32:17 +03:00
Markus Lehtonen
ad0db00a50 scripts: fix gh-pages build failure in prow
Work around stupid uid/gid magic that happens inside the jekyll docker image.
2020-10-22 21:31:05 +03:00
Kubernetes Prow Robot
c793796ba5
Merge pull request #367 from marquiz/devel/gh-pages
Integration with gh-pages
2020-10-08 03:16:16 -07:00
Markus Lehtonen
c5beeffb6a Enable automated update of gh-pagaes
Add 'scripts/github/update-gh-pages.sh' for updating gh-pages branch.
This new script intended for github actions integration and builds the
html documentation from the currently checked-out commit and updates the
corresponding version subfolder in the gh-pages branch. The version is
taken from GITHUB_REF environment variable and defaults to 'master' if
the env var is empty. For testing purposes or manual updates the
subfolder can also be given directly as a command line argument.

Add 'scripts/test-infra/build-gh-pages.sh' for verifying that site
(gh-pages) builds successfully. This is intended for integration with
kubernetes test-infra.

Finally, add Github workflow for updating gh-pages. This job is run on
master and release branches plus all tags starting with letter 'v'.
2020-10-08 10:54:24 +03:00
Markus Lehtonen
37cbf80c19 docs: customize the theme to show current version
Show current version (configured in _config.yml) in the sidebar instead
of the latest release from Github.
2020-10-08 10:53:27 +03:00
Markus Lehtonen
611612fd97 docs: add support for versioned documentation
Customize the Jekyll theme to add a simple list of versions.
2020-10-08 10:51:13 +03:00
Markus Lehtonen
5ec91935df Makefile: add rules for building html docs
Add rules for building and serving the html documentation inside a
container.
- 'make site-build' will build the html content unders docs/_site.
- 'make site-serve' builds the site content and serves it at
  http://localhost:4000/
2020-10-08 10:51:13 +03:00
Markus Lehtonen
d8ed7a7131 docs: initial site setup
Bootstrap a new Jekyll site with stub content for testing gh-pages
integration.

Use jekyll-rdt-theme from
https://github.com/rundocs/jekyll-rtd-theme
2020-10-08 10:50:04 +03:00
Kubernetes Prow Robot
851c2ac6a0
Merge pull request #366 from mrbobbytables/update-labels
Update triage/support label references to kind/support
2020-10-04 22:01:06 -07:00
Bob Killen
93c11c03bf
Update triage/support label references to kind/support
The label triage/support has been reclassified as kind/support. The
kind/* family of labels makes more logical sense, as they describe the
"kind" of thing an issue or PR is.

For more information, see the announcement email:
https://groups.google.com/g/kubernetes-dev/c/YcaJpsjjLKw/m/i15cLLx5CAAJ
2020-10-03 10:12:31 -04:00
Kubernetes Prow Robot
2c28e303af
Merge pull request #365 from marquiz/devel/deploy-namespace
Makefile: set default deployment ns to node-feature-discovery
2020-10-01 06:50:53 -07:00
Markus Lehtonen
5d4484a1d9 Makefile: set default deployment ns to node-feature-discovery
Change the default namespace used in deployment yamls from 'kube-system'
to 'node-feature-discovery'. Sync with what the templates have. Also,
this should be a safer and more desirable default for people just trying
out node-feature-discovery.
2020-10-01 13:52:10 +03:00
Carlos Arango Gutierrez
0896223c69
Enable issue templates (#363)
* Enable issue templates

This commit adds templates for bug report, feature request and support
related issues.

Signed-off-by: Carlos Eduardo Arango Gutierrez <carangog@redhat.com>

* Update .github/ISSUE_TEMPLATE/bug-report.md

Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com>

* Update .github/ISSUE_TEMPLATE/enhancement.md

Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com>

* Update .github/ISSUE_TEMPLATE/support.md

Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com>

Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com>
2020-09-22 11:17:09 -07:00
Kubernetes Prow Robot
5604ae4feb
Merge pull request #364 from marquiz/devel/scripts-overrides
scripts: one more variable override fix in test-e2e.sh
2020-09-22 03:54:47 -07:00
Markus Lehtonen
d77398bc50 scripts: one more variable override fix in test-e2e.sh 2020-09-22 10:29:29 +03:00
Kubernetes Prow Robot
8628dbb1e3
Merge pull request #362 from marquiz/devel/scripts-overrides
Polish test-infra scripts a bit
2020-09-21 15:34:47 -07:00
Markus Lehtonen
1e3c971651 scripts: don't use '-e' command line option for make
There is no reason to override variables from the environment anymore.
2020-09-15 11:53:50 +03:00
Markus Lehtonen
e8e3fce851 scripts: explicitly override VERSION in push-image.sh
Without using -e to override variables from the environment.
2020-09-15 11:46:48 +03:00
Kubernetes Prow Robot
f0ef38b84e
Merge pull request #334 from mythi/custom-adds
custom: Add rules for kconfig and cpuid
2020-09-14 06:04:58 -07:00
Mikko Ylinen
e2ee7c6fca source/custom: add rules for cpuid and kconfig
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-09-14 12:07:35 +03:00
Mikko Ylinen
d1cce3ba29 source/custom: do not return on rule errors
Skip to the next rule instead of returning immediately on
rule errors. For instance, if the static rules failed, user
provided rules would never be processed.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-09-14 12:07:35 +03:00
Mikko Ylinen
8b156d49fc source/kernel: add internal helper to get kernel version
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-09-14 12:07:35 +03:00
Mikko Ylinen
aeb7583315 source/kernel: move kconfig to a shared internal package
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-09-14 12:07:33 +03:00
Mikko Ylinen
3fd314b600 source/kernel: add more search paths
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-09-14 12:06:23 +03:00
Mikko Ylinen
109da6c980 source/cpu: move cpuid code to a shared internal package
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-09-14 10:32:04 +03:00
Kubernetes Prow Robot
dc64fe0979
Merge pull request #360 from ArangoGutierrez/image_push
Drop gcloud auth for image pushing
2020-09-12 06:34:57 -07:00
Carlos Eduardo Arango Gutierrez
bac690813a
Drop gcloud auth for image pushing
gcloud auth call in push_image.sh test script is no longer needed

Signed-off-by: Carlos Eduardo Arango Gutierrez <carangog@redhat.com>
2020-09-12 07:38:38 -05:00
Kubernetes Prow Robot
d6b0f105eb
Merge pull request #359 from marquiz/devel/drop-travis
Drop TravisCI integration
2020-09-11 04:34:14 -07:00
Markus Lehtonen
006234b69d Drop TravisCI integration
All CI has been migrated over to Kubernetes test-infra.
2020-09-11 08:19:36 +03:00
Kubernetes Prow Robot
48354d0cba
Merge pull request #358 from marquiz/devel/demo-fix
Fix demo
2020-09-10 16:32:14 -07:00
Markus Lehtonen
02d68ba491 demo: make demo runnable again
Fix workload template specs:
- update node affinity in "demo-pod-with-discovery.cloverleaf"
- fix broken "demo-pod-without-discovery"

Fix runner scripts to be runnable from anywhere gqYour current working
dir shouldn't matter. Also make the scripts exit on any error. Also
remove trailing whitespace.

Minor fixes in README.
2020-09-10 17:09:53 +03:00
Kubernetes Prow Robot
868699445f
Merge pull request #357 from marquiz/devel/readme
README: drop References and unused links
2020-09-10 04:47:45 -07:00