mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-16 21:38:23 +00:00
Code Activity

Merge pull request #1895 from marquiz/devel/docs-quoting

Browse source 
docs: quote shell snippets containing urls with query parameters
This commit is contained in:
Kubernetes Prow Robot 2024-10-02 16:01:50 +01:00 • committed by GitHub
commit d963cd3f8f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -12,7 +12,7 @@ features and system configuration!
#### Quick-start – the short-short version #### Quick-start – the short-short version
```bash ```bash
$ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.16.4 $ kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.16.4"
namespace/node-feature-discovery created namespace/node-feature-discovery created
customresourcedefinition.apiextensions.k8s.io/nodefeaturerules.nfd.k8s-sigs.io created customresourcedefinition.apiextensions.k8s.io/nodefeaturerules.nfd.k8s-sigs.io created
customresourcedefinition.apiextensions.k8s.io/nodefeatures.nfd.k8s-sigs.io created customresourcedefinition.apiextensions.k8s.io/nodefeatures.nfd.k8s-sigs.io created
@ -38,7 +38,7 @@ $ kubectl -n node-feature-discovery get all
pod/nfd-worker-nwdp6 1/1 Running 0 18s pod/nfd-worker-nwdp6 1/1 Running 0 18s
... ...
$ kubectl get no -o json | jq '.items[].metadata.labels' $ kubectl get no -o json | jq ".items[].metadata.labels"
{ {
"kubernetes.io/arch": "amd64", "kubernetes.io/arch": "amd64",
"kubernetes.io/os": "linux", "kubernetes.io/os": "linux",

16
docs/deployment/kustomize.md
View file

@ -26,7 +26,7 @@ later is required.
The kustomize overlays provided in the repo can be used directly: The kustomize overlays provided in the repo can be used directly:
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
``` ```
This will required RBAC rules and deploy nfd-master (as a deployment) and This will required RBAC rules and deploy nfd-master (as a deployment) and
@ -77,7 +77,7 @@ The `default-job` overlay may be used to achieve this:
```bash ```bash
NUM_NODES=$(kubectl get no -o jsonpath='{.items[*].metadata.name}' | wc -w) NUM_NODES=$(kubectl get no -o jsonpath='{.items[*].metadata.name}' | wc -w)
kubectl kustomize https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref={{ site.release }} | \ kubectl kustomize "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref={{ site.release }}" | \
sed s"/NUM_NODES/$NUM_NODES/" | \ sed s"/NUM_NODES/$NUM_NODES/" | \
kubectl apply -f - kubectl apply -f -
``` ```
@ -94,7 +94,7 @@ deployed as separate pods. The `master-worker-topologyupdater` overlay may be
used to achieve this: used to achieve this:
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref={{ site.release }}"
``` ```
@ -104,7 +104,7 @@ To deploy just nfd-topology-updater (without nfd-master and nfd-worker)
use the `topologyupdater` overlay: use the `topologyupdater` overlay:
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
``` ```
@ -114,8 +114,8 @@ are deployed as separate pods;
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
``` ```
@ -126,8 +126,8 @@ to scrape metrics from node-feature-discovery,
run the following command: run the following command:
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prometheus?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prometheus?ref={{ site.release }}"
``` ```
## Uninstallation ## Uninstallation

4
docs/deployment/uninstallation.md
View file

@ -24,9 +24,9 @@ nfd-related node labels, annotations, extended resources and taints from the
cluster. cluster.
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }}"
kubectl -n node-feature-discovery wait job.batch/nfd-master --for=condition=complete && \ kubectl -n node-feature-discovery wait job.batch/nfd-master --for=condition=complete && \
kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }} kubectl delete -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }}"
``` ```
> **NOTE:** You must run prune before removing the RBAC rules (serviceaccount, > **NOTE:** You must run prune before removing the RBAC rules (serviceaccount,

6
docs/get-started/quick-start.md
View file

@ -14,7 +14,7 @@ Deploy with kustomize -- creates a new namespace, service and required RBAC
rules and deploys nfd-master and nfd-worker daemons. rules and deploys nfd-master and nfd-worker daemons.
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
``` ```
## Verify ## Verify
@ -34,7 +34,7 @@ deployment.apps/nfd-master 1/1 1 1 17s
Check that NFD feature labels have been created Check that NFD feature labels have been created
```bash ```bash
$ kubectl get no -o json | jq '.items[].metadata.labels' $ kubectl get no -o json | jq ".items[].metadata.labels"
{ {
"kubernetes.io/arch": "amd64", "kubernetes.io/arch": "amd64",
"kubernetes.io/os": "linux", "kubernetes.io/os": "linux",
@ -82,7 +82,7 @@ To deploy nfd-topology-updater use the `topologyupdater` kustomize
overlay. overlay.
```bash ```bash
kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }} kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
``` ```
### Verify nfd-topology-updater ### Verify nfd-topology-updater