📖 (doc): getting started: fix information about make command for generating manifests

[vtrenton]

make generate does not generate the CRDs in config/crd/base the correct command to accomplish this is make manifests. See Makefile:

generate: controller-gen  ## Generate code (deepcopy)
	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."

manifests: controller-gen  ## Generate manifests (CRDs, RBAC, etc.)
	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases

fixes: #4305

[k8s-ci-robot]

Welcome @vtrenton!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @vtrenton. 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 /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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[vtrenton]

Also fixed a simple yam -> yaml in the same section.

[camilamacedo86]

Here we need the macke generate right?
Since we changed the spec

[vtrenton]

Thanks for the quick response!
make generate doesn't seem to do what this is saying this will do... Sorry very new to kubebuilder so I could be doing something wrong here:

(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ tree config/crd/
config/crd/
├── kustomization.yaml
└── kustomizeconfig.yaml

1 directory, 2 files
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ make generate
/home/trent/Source/kubebuilder-demo/memcached-operator/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./..."
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ tree config/crd/
config/crd/
├── kustomization.yaml
└── kustomizeconfig.yaml

1 directory, 2 files
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ make manifests
/home/trent/Source/kubebuilder-demo/memcached-operator/bin/controller-gen rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ tree config/crd/
config/crd/
├── bases
│   └── cache.example.com_memcacheds.yaml
├── kustomization.yaml
└── kustomizeconfig.yaml

2 directories, 3 files

just following along with the docs and running into this issue

[vtrenton]

ohh I see what you're saying - we need both commands I expect. that's a great point! let me see if I can come up with something more clean than make generate && make manifests

[camilamacedo86]

Yes both.

maybe:

To generate the required CRDs we will run make generate command to generate ... and make manisftes to generate the manifests under .... , which will call [controller-gen][controller-gen]

Something like?

[vtrenton]

I guess make build would be the "one-shot" do everything approach but it looks like I don't need to run make generate before running make manifests if my goal is generating manifest.

(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ ls config/crd/
kustomization.yaml  kustomizeconfig.yaml
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ ls api/v1alpha1/
groupversion_info.go  memcached_types.go
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ make manifests
/home/trent/Source/kubebuilder-demo/memcached-operator/bin/controller-gen rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $ ls -al config/crd/bases/
total 16
drwxr-xr-x 2 trent users 4096 Nov  8 12:37 .
drwxr-xr-x 3 trent users 4096 Nov  8 12:37 ..
-rw-r--r-- 1 trent users 4921 Nov  8 12:37 cache.example.com_memcacheds.yaml
(.venv) (devbox) [trent@Krum:~/Source/kubebuilder-demo/memcached-operator] [master] $

probably still need to run make generate at some point to generate the deep copy stuff...

[vtrenton]

To generate all required files, run make generate to create the DeepCopy implementations in api/v1alpha1/zz_generated.deepcopy.go, followed by make manifests to generate the CRD manifests under config/crd/bases. Both commands use [controller-gen][controller-gen] with different flags for code and manifest generation respectively.

does that wording sound OK? just want to make sure i'm not missing anything critical before making another commit - updating. Thanks for your help! I haven't read too far ahead in the docs yet so i'm not sure how verbose vs concise the wording should be!

[camilamacedo86]

Yes
I loved. Just a tiny refinement :-)

To generate all required files:

1. Run `make generate` to create the DeepCopy implementations in `api/v1alpha1/zz_generated.deepcopy.go`.

2. Then, run `make manifests` to generate the CRD manifests under `config/crd/bases` and a sample for it under `config/crd/samples`.

Both commands use [controller-gen][controller-gen] with different flags for code and manifest generation, respectively.

WDYT?

[vtrenton]

ohhh that is a wonderful callout in reguards to the sample dir as well!

That is perfect - thanks a bunch for the help, I've commited the changes!

[camilamacedo86]

👍

[camilamacedo86]

Hi @vtrenton

It is all fine now. Really thank you for the contribution 🥇
Just one nit. For we are able to merge all changes need to be in one commit.
Can you please squash the commit?

[vtrenton]

Thanks @camilamacedo86
commits have been squashed. Please let me know if anything else is needed!

[camilamacedo86]

Great 🥇

/approved
/lgtm
/ok-to-test

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, vtrenton

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 [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment