📖 Add Documentation for CRD and Operator Scope #3804
Conversation
sarthaksarthak9
commented
Mar 3, 2024
sarthaksarthak9
commented
- Add crd-scope and operator-scope documentation under Reference section and update summary
- Add doc about Operator and CRD scope #3623
k8s-ci-robot
added
cncf-cla: yes
|
Hi @sarthaksarthak9. 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/test-infra repository. |
k8s-ci-robot
added
the
size/L
…n and update summary
|
|
||
| - **Namespaced**: This restricts CR access and management to the specific namespace where the CR is created. | ||
|
|
||
| For projects employing the Operator SDK in Go, the `operator-sdk create api` command has a `--namespaced flag`. This flag determines the value of `spec.scope` and modifies the corresponding `types.go` file for the resource. In other operator types, the scope can be directly set by editing the `spec.scope` field in the CRD's YAML manifest file. |
There was a problem hiding this comment.
We need to adapt the code since it is the Kubebuilder docs and not Operator-SDK one
Can you please ajust the format
There was a problem hiding this comment.
@camilamacedo86 Will this work here "The scope can be directly set by editing the spec.scope field in the CRD's YAML manifest file" ?
There was a problem hiding this comment.
Yes, I would recommend you:
- Follow the Quick Start: https://book.kubebuilder.io/getting-started
- Then, test out those options
for you be able to explain and doc something you need to experiment first. The doc is just a final result of the work.
I hope that helps out.
There was a problem hiding this comment.
@varshaprasad96 @everettraven @rashansmith
The idea here would be move the content that is valid for kubebuilder docs
Therefore, it would be possible simplify in a follow up the Operator-SDK docs as well and keep there only what is Operator-SDK specific and allow you folks just link the pages.
So, please feel free to check this one and give your inputs as well as let us know wdyt?
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: sarthaksarthak9 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Closed in favor of : #4035 @sarthaksarthak9 see the above PR to have a better idea about what was expected in this one |
