2019-01-11 15:55:28 +02:00
/ *
Copyright 2019 The Kubernetes Authors .
Licensed under the Apache License , Version 2.0 ( the "License" ) ;
you may not use this file except in compliance with the License .
You may obtain a copy of the License at
http : //www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing , software
distributed under the License is distributed on an "AS IS" BASIS ,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND , either express or implied .
See the License for the specific language governing permissions and
limitations under the License .
* /
2016-07-01 11:46:05 -07:00
package main
import (
2016-07-14 14:17:27 -07:00
"fmt"
2016-07-01 11:46:05 -07:00
"log"
2016-07-19 15:35:42 -07:00
"strings"
2018-04-11 19:33:06 +03:00
"time"
2016-07-01 11:46:05 -07:00
2018-03-01 20:49:57 +02:00
"github.com/docopt/docopt-go"
2019-02-08 21:43:54 +02:00
worker "sigs.k8s.io/node-feature-discovery/pkg/nfd-worker"
2019-01-10 18:02:53 +02:00
"sigs.k8s.io/node-feature-discovery/pkg/version"
2016-07-01 11:46:05 -07:00
)
2016-07-19 15:35:42 -07:00
const (
2019-01-11 15:55:28 +02:00
// ProgramName is the canonical name of this program
ProgramName = "nfd-worker"
2016-07-19 15:35:42 -07:00
)
2016-07-01 11:46:05 -07:00
func main ( ) {
2016-07-14 14:17:27 -07:00
// Assert that the version is known
2020-03-20 07:21:43 +02:00
if version . Undefined ( ) {
log . Printf ( "WARNING: version not set! Set -ldflags \"-X sigs.k8s.io/node-feature-discovery/pkg/version.version=`git describe --tags --dirty --always`\" during build or run." )
2016-07-01 11:46:05 -07:00
}
2016-12-16 15:50:48 -08:00
// Parse command-line arguments.
2019-01-11 15:55:28 +02:00
args , err := argsParse ( nil )
if err != nil {
2019-02-08 21:43:54 +02:00
log . Fatalf ( "failed to parse command line: %v" , err )
2019-01-11 15:55:28 +02:00
}
2016-12-16 15:50:48 -08:00
2019-02-08 21:43:54 +02:00
// Get new NfdWorker instance
instance , err := worker . NewNfdWorker ( args )
2018-07-06 14:11:07 +03:00
if err != nil {
2019-02-08 21:43:54 +02:00
log . Fatalf ( "Failed to initialize NfdWorker instance: %v" , err )
2018-07-06 14:11:07 +03:00
}
2019-02-08 21:43:54 +02:00
if err = instance . Run ( ) ; err != nil {
log . Fatalf ( "ERROR: %v" , err )
2016-12-16 15:50:48 -08:00
}
}
// argsParse parses the command line arguments passed to the program.
// The argument argv is passed only for testing purposes.
2019-02-08 21:43:54 +02:00
func argsParse ( argv [ ] string ) ( worker . Args , error ) {
args := worker . Args { }
2016-07-19 15:35:42 -07:00
usage := fmt . Sprintf ( ` % s .
Usage :
2018-04-11 19:33:06 +03:00
% s [ -- no - publish ] [ -- sources = < sources > ] [ -- label - whitelist = < pattern > ]
2018-07-06 14:11:07 +03:00
[ -- oneshot | -- sleep - interval = < seconds > ] [ -- config = < path > ]
2019-01-30 15:02:50 +02:00
[ -- options = < config > ] [ -- server = < server > ] [ -- server - name - override = < name > ]
2019-01-30 14:54:51 +02:00
[ -- ca - file = < path > ] [ -- cert - file = < path > ] [ -- key - file = < path > ]
2016-07-19 15:35:42 -07:00
% s - h | -- help
% s -- version
Options :
2016-10-17 10:24:37 -07:00
- h -- help Show this screen .
-- version Output version and exit .
2018-07-06 14:11:07 +03:00
-- config = < path > Config file to use .
2019-01-11 15:55:28 +02:00
[ Default : / etc / kubernetes / node - feature - discovery / nfd - worker . conf ]
2018-09-21 11:26:57 +03:00
-- options = < config > Specify config options from command line . Config
options are specified in the same format as in the
config file ( i . e . json or yaml ) . These options
will override settings read from the config file .
[ Default : ]
2019-01-29 16:21:48 +02:00
-- ca - file = < path > Root certificate for verifying connections
[ Default : ]
2019-01-30 14:54:51 +02:00
-- cert - file = < path > Certificate used for authenticating connections
[ Default : ]
-- key - file = < path > Private key matching -- cert - file
[ Default : ]
2019-01-11 15:55:28 +02:00
-- server = < server > NFD server address to connecto to .
[ Default : localhost : 8080 ]
2019-01-30 15:02:50 +02:00
-- server - name - override = < name > Name ( CN ) expect from server certificate , useful
in testing
[ Default : ]
2016-10-17 10:24:37 -07:00
-- sources = < sources > Comma separated list of feature sources .
usb: Add support for USB device discovery
This builds on the PCI support to enable the discovery of USB devices.
This is primarily intended to be used for the discovery of Edge-based
heterogeneous accelerators that are connected via USB, such as the Coral
USB Accelerator and the Intel NCS2 - our main motivation for adding this
capability to NFD, and as part of our work in the SODALITE H2020
project.
USB devices may define their base class at either the device or
interface levels. In the case where no device class is set, the
per-device interfaces are enumerated instead. USB devices may
furthermore have multiple interfaces, which may or may not use the
identical class across each interface. We therefore report device
existence for each unique class definition to enable more fine-grained
labelling and node selection.
The default labelling format includes the class, vendor and device
(product) IDs, as follows:
feature.node.kubernetes.io/usb-fe_1a6e_089a.present=true
As with PCI, a subset of device classes are whitelisted for matching.
By default, there are only a subset of device classes under which
accelerators tend to be mapped, which is used as the basis for
the whitelist. These are:
- Video
- Miscellaneous
- Application Specific
- Vendor Specific
For those interested in matching other classes, this may be extended
by using the UsbId rule provided through the custom source. A full
list of class codes is provided by the USB-IF at:
https://www.usb.org/defined-class-codes
For the moment, owing to a lack of a demonstrable use case, neither
the subclass nor the protocol information are exposed. If this
becomes necessary, support for these attributes can be trivially
added.
Signed-off-by: Paul Mundt <paul.mundt@adaptant.io>
2020-05-14 22:32:55 +02:00
[ Default : cpu , custom , iommu , kernel , local , memory , network , pci , storage , system , usb ]
2016-10-25 17:05:55 -07:00
-- no - publish Do not publish discovered features to the
cluster - local Kubernetes API server .
-- label - whitelist = < pattern > Regular expression to filter label names to
2020-05-20 23:19:09 +03:00
publish to the Kubernetes API server .
NB : the label namespace is omitted i . e . the filter
is only applied to the name part after '/' .
[ Default : ]
2018-04-11 19:33:06 +03:00
-- oneshot Label once and exit .
-- sleep - interval = < seconds > Time to sleep between re - labeling . Non - positive
value implies no re - labeling ( i . e . infinite
sleep ) . [ Default : 60 s ] ` ,
2016-07-19 15:35:42 -07:00
ProgramName ,
ProgramName ,
ProgramName ,
ProgramName ,
)
2020-05-19 15:21:21 +03:00
arguments , _ := docopt . ParseArgs ( usage , argv ,
fmt . Sprintf ( "%s %s" , ProgramName , version . Get ( ) ) )
2016-07-19 15:35:42 -07:00
// Parse argument values as usable types.
2018-04-11 19:33:06 +03:00
var err error
2019-02-08 21:43:54 +02:00
args . CaFile = arguments [ "--ca-file" ] . ( string )
args . CertFile = arguments [ "--cert-file" ] . ( string )
args . ConfigFile = arguments [ "--config" ] . ( string )
args . KeyFile = arguments [ "--key-file" ] . ( string )
args . NoPublish = arguments [ "--no-publish" ] . ( bool )
args . Options = arguments [ "--options" ] . ( string )
args . Server = arguments [ "--server" ] . ( string )
args . ServerNameOverride = arguments [ "--server-name-override" ] . ( string )
args . Sources = strings . Split ( arguments [ "--sources" ] . ( string ) , "," )
args . LabelWhiteList = arguments [ "--label-whitelist" ] . ( string )
args . Oneshot = arguments [ "--oneshot" ] . ( bool )
args . SleepInterval , err = time . ParseDuration ( arguments [ "--sleep-interval" ] . ( string ) )
2018-04-11 19:33:06 +03:00
if err != nil {
2019-01-11 15:55:28 +02:00
return args , fmt . Errorf ( "invalid --sleep-interval specified: %s" , err . Error ( ) )
2018-04-11 19:33:06 +03:00
}
2019-01-11 15:55:28 +02:00
return args , nil
2016-12-16 15:50:48 -08:00
}