Doc: Fix tilt up issue in feature discovering in developer guide #1889
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
Hi @ChaoyiHuang. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
needs-ok-to-test
✅ Deploy Preview for kubernetes-sigs-nfd ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ChaoyiHuang
force-pushed
the
fixtiltup
branch
from
4431607 to
8f01cad
Compare
|
Fixes: #1855 |
docs/developer-guide/index.md
Outdated
| - Create registry first through the command | ||
| ``` | ||
| cat <<EOF | ctlptl apply -f - | ||
| apiVersion: ctlptl.dev/v1alpha1 | ||
| kind: Registry | ||
| name: ctlptl-registry | ||
| port: 5005 | ||
| ``` | ||
| or | ||
| ``` | ||
| ctlptl create registry ctlptl-registry --port=5005 | ||
| ``` | ||
| - Create a Kubernetes cluster, which will be deployed onto controller node and woker nodes running inside docker containers. Make sure mounting necessary host folders to worker nodes for feature discovery. For example, if k3d is used for cluster creation (please note that the mounted folders for feature discovering should be set to read only in production environment): | ||
| ``` | ||
| cat <<EOF | ctlptl apply -f - | ||
| apiVersion: ctlptl.dev/v1alpha1 | ||
| kind: Cluster | ||
| registry: ctlptl-registry | ||
| product: k3d | ||
| k3d: | ||
| v1alpha5Simple: | ||
| volumes: | ||
| - volume: /boot:/boot | ||
| nodeFilters: | ||
| - server:0 | ||
| - agent:* | ||
| - volume: /lib:/lib | ||
| nodeFilters: | ||
| - server:0 | ||
| - agent:* | ||
| EOF | ||
| ``` |
There was a problem hiding this comment.
Thanks for the example! I believe we should avoid including a specific cluster installation method since it ties us to particular installers, which aren't standardized. For instance, v1alpha5Simple embeds k3d-specific configuration. Could we instead add a note highlighting the directories that need to be mounted?
k8s-ci-robot
added
size/S
|
Thank you @ChaoyiHuang for the patch. One nit: could you wrap the lines (like the rest of the file)? Other than that looks good to me. @fmuyassarov any further comments? /ok-to-test |
k8s-ci-robot
added
ok-to-test
Oh the CI (mdlint) was nitting about the same thing, and a few others |
The issue is due to the k3d/kind cluster created by ctlptl will run inside containers(it will serve as the virtual hosts). Host folders which will be scaned by the nfd feature discovery should be mounted into the container ( the virtual host). otherwise the nfd-worker container which run inside the virtual host will just see the default base image rootfs /boot, /lib folders, which are usually empty, leads to the discovey failure. Signed-off-by: Chaoyi Huang <[email protected]>
ChaoyiHuang
force-pushed
the
fixtiltup
branch
from
3c184c3 to
d08ea5e
Compare
k8s-ci-robot
added
size/M
yeah, fixed. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ChaoyiHuang, marquiz The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 40379f1afd3a9d1ef3e3145a18f4d60f02ae3bb1
|
The issue is due to the k3d/kind cluster created by ctlptl will run inside containers(it will serve as the virtual hosts).
Host folders which will be scaned by the nfd feature discovery should be mounted into the container ( the virtual host). otherwise the nfd-worker container which run inside the virtual host will just see the default base image rootfs /boot, /lib folders, which are usually empty, leads to the discovey failure.