User guide for hook sidecar

[dharmit]

Fixes #726

[kubevirt-bot]

Hi @dharmit. Thanks for your PR.

I'm waiting for a kubevirt member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[dharmit]

/cc @victortoso

[oreillymj]

I know this sounds dumb, but the documentation would benefit from have the instructions on how to enable the sidecar feature gate, especially since it's case sensitive. The doc doesn't say it's behind a feature gate so users may assume that it'll work by default, which is obviously not the case. Is my spelling in the yaml below is correct?

cat << END > enable-sidecar-feature-gate.yaml
---
apiVersion: kubevirt.io/v1
kind: KubeVirt
metadata:
  name: kubevirt
  namespace: kubevirt
spec:
  configuration:
    developerConfiguration: 
      featureGates:
        - Sidecar
END

kubectl apply -f enable-sidecar-feature-gate.yaml

[dharmit]

I know this sounds dumb, but the documentation would benefit from have the instructions on how to enable the sidecar feature gate, especially since it's case sensitive. The doc doesn't say it's behind a feature gate so users may assume that it'll work by default, which is obviously not the case.

I don't think it's dumb. But we can put a link to feature gate section and say that the feature gate Sidecar needs to be enabled to use this.

[dharmit]

@victortoso WDYT about the docs I have added for precloudinitiso?

[victortoso]

@dharmit rebasing should probably fix the CI

[victortoso]

/lgtm Thanks!

[dharmit]

@aburdenthehand @cwilkers can one of you PTAL? I don't know who else to ping on this.

[dharmit]

@aburdenthehand thanks for taking the time to review and for your suggestions. I'm not a native English speaker, but I like writing docs. So the questions I have asked are out of genuine curiosity to learn more from a native person. :)

[aburdenthehand]

/lgtm Thanks @dharmit !

[dharmit]

@aburdenthehand @cwilkers can one of give an ok-to-test on this PR?

[cwilkers]

@aburdenthehand @cwilkers can one of give an ok-to-test on this PR?

/ok-to-test

It recently came to my attention that ok-to-test really has no effect on the docs repositories since our CI process here basically just creates previews and runs within Netlify's service.

[dharmit]

@aburdenthehand @cwilkers can one of give an ok-to-test on this PR?

/ok-to-test

It recently came to my attention that ok-to-test really has no effect on the docs repositories since our CI process here basically just creates previews and runs within Netlify's service.

Thanks @cwilkers ! Can you do approve if this looks OK to you?

[cwilkers]

/lgtm /approve

[kubevirt-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cwilkers

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: - ~~[OWNERS](https://github.com/kubevirt/user-guide/blob/main/OWNERS)~~ [cwilkers] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment