Release v0.14.0 - Githubissues

marquiz commented 1 year ago

Release Checklist

[ ] All OWNERS must LGTM the release proposal
[x] Verify that the changelog in this issue is up-to-date
[x] For major releases (v0.$MAJ.0) create new release branch
- [x] an OWNER creates a vanilla release branch with git branch release-0.$MAJ master
- [x] An OWNER pushes the new release branch with git push release-0.$MAJ
- [x] Create Prow pre-submit job configuration for the new release branch in K8s test-infra, submit a PR
- [x] Wait for the test-infra Prow config PR to be merged
[x] Run hack/prepare-release.sh $VERSION to turn references to point to the upcoming release (README, deployment templates, docs configuration, test/e2e flags), submit a PR against the release branch
An OWNER prepares a draft release
- [x] Create a draft release at Github releases page
- [x] Write the change log into the draft release
- [x] Upload release artefacts generated by prepare-release.sh script above to the draft release
[x] An OWNER runs git tag -s $VERSION and inserts the changelog into the tag description.
[x] An OWNER pushes the tag with git push $VERSION
- Triggers prow to build and publish a staging container image gcr.io/k8s-staging-nfd/node-feature-discovery:$VERSION
- Triggers build of the documentation and publish it at https://kubernetes-sigs.github.io/node-feature-discovery/0.$MAJ/
[x] Submit a PR against k8s.io, updating registry.k8s.io/images/k8s-staging-nfd/images.yaml to promote the container images (both "full" and "minimal" variants) to production
[x] Wait for the PR to be merged and verify that the image (registry.k8s.io/nfd/node-feature-discovery:$VERSION) is available.
[x] Publish the draft release prepared at the Github releases page which will also trigger a Helm repo index update to add the latest release
[x] Add a link to the tagged release in this issue.
[x] For a major release
- [x] Send an announcement email to dev@kubernetes.io with the subject [ANNOUNCE] node-feature-discovery $VERSION is released
- [x] Add a link to the release announcement in this issue
[x] For a major release (or a point release of the latest major release), update README in master branch
- [x] Update references e.g. by running hack/prepare-release.sh $VERSION but only committing README.md, and, submit a PR
- [x] Wait for the PR to be merged
[x] For a major release, create an unannotated devel tag in the master branch, on the first commit that gets merged after the release branch has been created (presumably the README update commit above), and, push the tag: DEVEL=v0.$(($MAJ+1)).0-devel; git tag $DEVEL master && git push $DEVEL This ensures that the devel builds on the master branch will have a meaningful version number.
[ ] Close this issue

What's new

NodeFeature API

The NodeFeature API is now enabled by default. The new CRD-based API replaces the previous gRPC-based communication between nfd-master and nfd-worker and, reducing network traffic and allows changes in NodeFeatureRules to take effect immediately (independent of the sleep-interval of nfd-worker). NodeFeature API can also be used to implement 3rd party extensions, see customization guide for more details.

Garbage collection of stale NodeFeature objects was added in the form of nfd-gc daemon.

The gRPC API is now deprecated and will be removed in a future release. The related command-line flags are also deprecated (and don't have any effect when NodeFeature API is in use):

nfd-master: -ca-file, -cert-file, -key-file, -port, -verify-node-name
nfd-worker: -ca-file, -cert-file, -key-file, -server, -server-name-override

Metrics

NFD now provides Prometheus metrics for better observability. Also, the Helm and kustomize deployments support enabling metrics collection with the Prometheus operator. See the documentation for more information about the available metrics and deployment instructions.

Hooks disabled by default

The deprecation of nfd-worker hooks continues, disabling them by default in v0.14. Potential users of hooks are encouraged to switch to use the NFD CRDs (NodeFeature and NodeFeatureRule) or feature files. Hooks can still be enabled with the sources.local.hooksEnabled configuration option.

Feature files

Expiry time: NFD now supports specifying an expiry time for the features specified in a feature file, providing better lifecycle management for the feature labels. See the documentation for more details.

Size limit: There is now a 64kB size limit for feature files.

Miscellaneous

NodeFeatureRule API

Dynamic values for labels is now supported by using the @ notation, see documentation for more details.

NFD-Master

support for leader election was added, enabling high-availability deployments with multiple-replicas of nfd-master (with the NodeFeature API enabled)
dynamically configurable logging parameters via the config file
configurable resync period for the CRD controller
parallelized node updates, speeding up simultaneous updates of large number of nodes (e.g. update in NodeFeatureRules in a big cluster), can be controlled with the -nfd-api-parallelism flag

CPU features

Detection of Intel TDX guests is now supported.

Logging

The project was migrated structured logging, making log messages more consistent, better machine parseable and enables future improvements in logging.

Support policy

The project now officially documented it's supported versions and deprecation policy, see the documentation for details.

List of PRs

test/e2e: use proper context (#1154)
deps: Update kubernetes to v1.27.1 (#1155)
generate: update k8s code-generator to v0.27.1 (#1156)
generate: update protoc to v22.3 (#1157)
generate: update controller-gen to v0.11.3 (#1158)
generate: update mockery to v2.25.1 (#1159)
nfd-master: support noPublish with -prune (#1161)
nfd-master: fix -prune (#1160)
nfd-master: don't create emtpy annotations (#1166)
nfd-master: fix a crash when processing NodeFeatureRules (#1173)
pkg/nfd-master/nfd-master.go: Fix typo (#1171)
nfd-master: reject malformed extended resource dynamic capacity assignment (#1169)
go.mod: update deps (#1178)
OWNERS: add ArangoGutierrez as an approver (#1180)
feat: add master resync period configurability (#1139)
nfd-topology-updater: fix wrong kubelet_internal_checkpoint path and compare basename to full path (#1167)
docs: add missing .md suffix to internal references (#1189)
nfd-master: log node name when processing NodeFeatureRules (#1191)
scripts/test-infra: provide PR info to codecov (#1194)
Match usage and example for prepare-release.sh (#1196)
apis/nfd: add unit tests for Feature type (#1190)
Update README to v0.13.1 (#1197)
scripts/test-infra: provide PR base SHA to codecov (#1199)
codecov: drop required minimum coverage ratio of a commit to 0% (#1200)
codecov: drop required minimum coverage ratio at patch level (#1201)
nfd-master: refactor api-controller object handling (#1198)
nfd-master: refactor filtering of labels, taints and ERs (#1202)
helm: fix mount for nfd-master config (#1204)
nfd-master: fix resync period config option (#1185)
deployment/helm: fix default for kubeletStateDir parameter (#1207)
deployment/kustomize: drop pod-resources mount for topology-updater (#1208)
test/e2e: refactor matching of node properties (#1184)
deployment/helm: avoid overlapping mount paths on topology-updater (#1212)
deployment/helm: user dedicated serviceaccount for topology-updater (#1213)
deployment/helm: improve handling of topologyUpdater.kubeletStateFiles (#1211)
topology-updater: use node IP in the default configz URI (#1218)
e2e: delete CRs only if found (#1221)
Add leader election for nfd-master (#1219)
Fixed typo in Header under deployment/kustomize.md (#1222)
nfd-master: use close for stop channel (#1227)
scripts/test-infra: bump golangci-lint to v1.52.2 (#1230)
nfd-master: add validation of label names and values (#1228)
Migrate to structured logging (#1223)
scripts/test-infra: add logcheck to verify script (#1235)
Update README to v0.13.2 (#1238)
github: update new-release issue template (#1239)
feat: support dynamic values for labels in the NodeFeatureRule (#1226)
feat: parallelize nodes update (#1133)
cpu: Discover TDX guests based on cpuid information (#1240)
deployment/kustomize: use a named port for nfd gRPC service (#1243)
Fix missing apostrophe for jq (#1245)
Fix a typo on nfd-master cmd (#1244)
Removal of the bases field as it is deprecated by kustomize (#1246)
Docs: Fix typo on customization-guide (#1247)
hooks: disable hooks by default from v0.14 (#1182)
Remove pkg's imported twice (#1248)
fix typo in helm chart (#1253)
Stop ticker in time to avoid memory leak (#1255)
nfd-master: check for nil references in nfdAPIUpdateAllNodes (#1258)
cpu: Take cgroupsv1 into account when reading misc.capacity (#1265)
go.mod: update kubernetes to v1.27.4 (#1268)
github: update assignees in new-release issue template (#1274)
Enable metrics via prometheus operator (#1242)
README: update to v0.13.3 (#1276)
docs: document version and deprecation policy (#1279)
docs: fix toc of topology-updater and topology-gc reference (#1278)
docs: remove useless TOCs (#1280)
Add optional labels to the podmonitor (#1282)
docs: describe supported Kubernetes versions (#1277)
docs: deprecation policy for Helm chart params (#1283)
Fix Topology Manager policy and scope not being updated after NRT creation (#1256)
generate: bump tools to their latest versions (#1284)
Improve metrics (#1288)
docs: align metrics documentation with latest changes on naming (#1289)
docs: unify formatting of NOTEs (#1292)
source/local: trim whitespace from input (#1293)
source/local: support comments in input (#1294)
nfd-master: use term node update instead of labeling (#1291)
docs: document -metrics flag in command line reference (#1296)
fix empty hugepages in some numa nodes caused no such file or directory errors (#1287)
scripts/test-infra: update logcheck tool to v0.6.0 (#1299)
scripts/test-infra: bump golangci-lint to v1.54.0 (#1300)
Update kubernetes to v1.28.0 (#1302)
docs: update github-pages gem to v228 (#1303)
topology-gc: fix Stop (#1306)
topology-gc: rename run() (#1309)
topology-gc: rename runGC to garbageCollect() (#1310)
nfd-topology-updater: add metrics support (#1295)
topology-gc: refactor unit tests (#1307)
topology-gc: move initial GC out of startNodeInformer() (#1308)
topology-gc: simplify listing of node objects (#1311)
metrics: additional metrics for nfd-master (#1290)
Garbage collection of NodeFeature objects (#1305)
topology-updater: make -version always runnable (#1297)
go.mod: update kubernetes to v1.28.1 (#1315)
Makefile: increase golangci-lint timeout to 10min (#1320)
docs: use ruby docker image for building docs (#1319)
README: update to v0.13.4 (#1324)
test: add node updater pool unit tests (#1252)
docs: nfd-updater: clarify accounting (#1321)
nfd-updater: events: enable timer-only flow (#1325)
docs: demote hooks in the customization guide (#1326)
Feat: add expiry date for feature files (#1285)
Dockerfile: bump grpc-health-probe to v0.4.19 (#1327)
e2e/test: make the nfd-gc test pass on one-node cluster (#1328)
Enable NodeFeature API by default (#1329)
tls.md: Add note (#1332)
nfd_gc_test.go: fix multiple import of same pkg (#1333)
feat: add feature file size limit (#1335)
sources/custom: convert static rules to new format (#1336)
nfd-master: add config file options for logging (#1338)
Deprecate gRPC API (#1334)
Helm: conditionally add annotations if defined (#1331)

marquiz commented 1 year ago

See milestone v0.14. Annotations will likely not happen so there's only metrics support to be finished. We could cut the release in mid-July

PiotrProkop commented 1 year ago

@marquiz can we add this issue https://github.com/kubernetes-sigs/node-feature-discovery/issues/1254 to the v0.14 milestone? I'll work on it this week.

marquiz commented 1 year ago

/assign @PiotrProkop @fmuyassarov