📖 Add Documentation for CRD and Operator Scope #3804

sarthaksarthak9 · 2024-03-03T13:21:10Z

Add crd-scope and operator-scope documentation under Reference section and update summary
Add doc about Operator and CRD scope #3623

k8s-ci-robot · 2024-03-03T13:21:19Z

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 /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/test-infra repository.

k8s-ci-robot · 2024-03-03T13:21:26Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sarthaksarthak9
Once this PR has been reviewed and has the lgtm label, please assign varshaprasad96 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

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

docs/book/src/reference/crd-scope.md

…n and update summary

docs/book/src/reference/crd-scope.md

camilamacedo86 · 2024-03-29T08:25:04Z

docs/book/src/reference/crd-scope.md

+
+- **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.


We need to adapt the code since it is the Kubebuilder docs and not Operator-SDK one
Can you please ajust the format

@camilamacedo86 Will this work here "The scope can be directly set by editing the spec.scope field in the CRD's YAML manifest file" ?

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.

docs/book/src/reference/crd-scope.md

docs/book/src/reference/operator-scope.md

camilamacedo86

@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?

camilamacedo86 · 2024-05-05T08:05:49Z

docs/book/src/reference/crd-scope.md

+When creating a new API, the `--namespaced` flag controls whether the resulting CRD will be cluster or namespace scoped. By default, `--namespaced` is set to true which sets the scope to Namespaced. An example command to create a cluster-scoped API would be:
+
+```shell
+$ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource=true --controller=true --namespaced=false


Suggested change

$ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource=true --controller=true --namespaced=false

$ kubebuilder create api --group cache --version v1alpha1 --kind Memcached --resource=true --controller=true --namespaced=false

camilamacedo86 · 2024-05-05T08:06:18Z

docs/book/src/reference/crd-scope.md

@@ -0,0 +1,80 @@
+# CRD Scope
+
+This section dives into the Custom Resource Definitions (CRDs), specifically focusing on their scope and how it impacts their behavior. While we'll be exploring CRD scope in detail, for managing an operator's scope (like which namespaces it monitors), refer to the dedicated operator scope documentation.


Suggested change

This section dives into the Custom Resource Definitions (CRDs), specifically focusing on their scope and how it impacts their behavior. While we'll be exploring CRD scope in detail, for managing an operator's scope (like which namespaces it monitors), refer to the dedicated operator scope documentation.

camilamacedo86 · 2024-05-05T08:06:44Z

docs/book/src/reference/crd-scope.md

+
+This section dives into the Custom Resource Definitions (CRDs), specifically focusing on their scope and how it impacts their behavior. While we'll be exploring CRD scope in detail, for managing an operator's scope (like which namespaces it monitors), refer to the dedicated operator scope documentation.
+
+## Overview


Suggested change

## Overview

camilamacedo86 · 2024-05-05T08:07:22Z

docs/book/src/reference/crd-scope.md

+
+## Setting the Scope
+
+CRD manifests are usually generated using the `operator-sdk create api` command. These manifests reside in the `config/crd/bases` directory. Within a CRD's manifest, the `spec.scope` field controls its API scope. This field accepts two valid values:


Suggested change

CRD manifests are usually generated using the `operator-sdk create api` command. These manifests reside in the `config/crd/bases` directory. Within a CRD's manifest, the `spec.scope` field controls its API scope. This field accepts two valid values:

CRD manifests are usually generated using the `kubebuilder create api` command. These manifests reside in the `config/crd/bases` directory. Within a CRD's manifest, the `spec.scope` field controls its API scope. This field accepts two valid values:

camilamacedo86 · 2024-05-05T08:10:48Z

docs/book/src/reference/crd-scope.md

+```yaml
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.2.5
+  creationTimestamp: null
+  name: memcacheds.cache.example.com
+spec:
+  group: cache.example.com
+  names:
+    kind: Memcached
+    listKind: MemcachedList
+    plural: memcacheds
+    singular: memcached
+  scope: Namespaced
+  subresources:
+    status: {}
+... 


Suggested change

```yaml

apiVersion: apiextensions.k8s.io/v1beta1

kind: CustomResourceDefinition

metadata:

annotations:

controller-gen.kubebuilder.io/version: v0.2.5

creationTimestamp: null

name: memcacheds.cache.example.com

spec:

group: cache.example.com

names:

kind: Memcached

listKind: MemcachedList

plural: memcacheds

singular: memcached

scope: Namespaced

subresources:

status: {}

...

```yaml

apiVersion: apiextensions.k8s.io/v1

kind: CustomResourceDefinition

metadata:

annotations:

controller-gen.kubebuilder.io/version: v0.14.0

name: firstmates.crew.testproject.org

spec:

group: crew.testproject.org

names:

kind: FirstMate

listKind: FirstMateList

plural: firstmates

singular: firstmate

scope: Namespaced

...

camilamacedo86 · 2024-05-05T08:11:06Z

docs/book/src/reference/operator-scope.md

@@ -0,0 +1,269 @@
+# Operator Scope


Suggested change

# Operator Scope

# Manager Scope

camilamacedo86 · 2024-05-05T08:11:28Z

docs/book/src/reference/operator-scope.md

@@ -0,0 +1,269 @@
+# Operator Scope
+
+This section dives into the two crucial concepts of Custom Resource Definitions (CRDs) and Operators, specifically their respective scope and how both impact resource management in your Kubernetes environment.


Suggested change

This section dives into the two crucial concepts of Custom Resource Definitions (CRDs) and Operators, specifically their respective scope and how both impact resource management in your Kubernetes environment.

camilamacedo86 · 2024-05-05T08:11:36Z

docs/book/src/reference/operator-scope.md

+
+This section dives into the two crucial concepts of Custom Resource Definitions (CRDs) and Operators, specifically their respective scope and how both impact resource management in your Kubernetes environment.
+
+# Overview


Suggested change

# Overview

camilamacedo86 · 2024-05-05T08:12:27Z

docs/book/src/reference/operator-scope.md

+
+# Overview
+
+In the world of Kubernetes operators, scope defines the reach of an operator's management capabilities. This essentially means deciding which resources across your Kubernetes cluster the operator can watch and manage. Here's a breakdown of the two main options:


Suggested change

In the world of Kubernetes operators, scope defines the reach of an operator's management capabilities. This essentially means deciding which resources across your Kubernetes cluster the operator can watch and manage. Here's a breakdown of the two main options:

In the world of Kubernetes solutions, scope defines the reach of an projects's management capabilities. This essentially means deciding which resources across your Kubernetes cluster the manager can watch and manage. Here's a breakdown of the two main options:

camilamacedo86 · 2024-05-05T08:12:56Z

docs/book/src/reference/operator-scope.md

+
+## Defaults and Considerations:
+
+- The operator-sdk init command by default creates a cluster-scoped operator.


Suggested change

- The operator-sdk init command by default creates a cluster-scoped operator.

- The kubebuilder init command by default creates a cluster-scoped project.

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 3, 2024

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 3, 2024

k8s-ci-robot requested review from everettraven and rashmigottipati March 3, 2024 13:21

mateusoliveira43 reviewed Mar 4, 2024

View reviewed changes

docs/book/src/reference/crd-scope.md Outdated Show resolved Hide resolved

sarthaksarthak9 force-pushed the docs branch from 82b0802 to 05fb201 Compare March 5, 2024 13:24

sarthaksarthak9 requested a review from mateusoliveira43 March 5, 2024 13:26

mateusoliveira43 reviewed Mar 5, 2024

View reviewed changes

docs/book/src/reference/crd-scope.md Outdated Show resolved Hide resolved

Add crd-scope and operator-scope documentation under Reference sectio…

6594f25

…n and update summary

sarthaksarthak9 force-pushed the docs branch from 05fb201 to 6594f25 Compare March 5, 2024 14:06

camilamacedo86 reviewed Mar 29, 2024

View reviewed changes

docs/book/src/reference/crd-scope.md Show resolved Hide resolved

camilamacedo86 reviewed Mar 29, 2024

View reviewed changes

docs/book/src/reference/crd-scope.md Show resolved Hide resolved

camilamacedo86 reviewed Mar 29, 2024

View reviewed changes

docs/book/src/reference/operator-scope.md Show resolved Hide resolved

camilamacedo86 reviewed Mar 29, 2024

View reviewed changes

docs/book/src/reference/operator-scope.md Show resolved Hide resolved

camilamacedo86 reviewed Mar 29, 2024

View reviewed changes

Merge branch 'kubernetes-sigs:master' into docs

1fc717e

camilamacedo86 reviewed May 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 Add Documentation for CRD and Operator Scope #3804

📖 Add Documentation for CRD and Operator Scope #3804

sarthaksarthak9 commented Mar 3, 2024

k8s-ci-robot commented Mar 3, 2024

k8s-ci-robot commented Mar 3, 2024

camilamacedo86 Mar 29, 2024

sarthaksarthak9 Apr 23, 2024 •

edited

camilamacedo86 Apr 27, 2024

camilamacedo86 left a comment

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024

camilamacedo86 May 5, 2024 •

edited


		- 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.

	$ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource=true --controller=true --namespaced=false
	$ kubebuilder create api --group cache --version v1alpha1 --kind Memcached --resource=true --controller=true --namespaced=false

		@@ -0,0 +1,80 @@
		# CRD Scope

		This section dives into the Custom Resource Definitions (CRDs), specifically focusing on their scope and how it impacts their behavior. While we'll be exploring CRD scope in detail, for managing an operator's scope (like which namespaces it monitors), refer to the dedicated operator scope documentation.


		This section dives into the Custom Resource Definitions (CRDs), specifically focusing on their scope and how it impacts their behavior. While we'll be exploring CRD scope in detail, for managing an operator's scope (like which namespaces it monitors), refer to the dedicated operator scope documentation.

		## Overview


		## Setting the Scope

		CRD manifests are usually generated using the `operator-sdk create api` command. These manifests reside in the `config/crd/bases` directory. Within a CRD's manifest, the `spec.scope` field controls its API scope. This field accepts two valid values:

		@@ -0,0 +1,269 @@
		# Operator Scope

		This section dives into the two crucial concepts of Custom Resource Definitions (CRDs) and Operators, specifically their respective scope and how both impact resource management in your Kubernetes environment.


		This section dives into the two crucial concepts of Custom Resource Definitions (CRDs) and Operators, specifically their respective scope and how both impact resource management in your Kubernetes environment.

		# Overview


		# Overview

		In the world of Kubernetes operators, scope defines the reach of an operator's management capabilities. This essentially means deciding which resources across your Kubernetes cluster the operator can watch and manage. Here's a breakdown of the two main options:

	In the world of Kubernetes operators, scope defines the reach of an operator's management capabilities. This essentially means deciding which resources across your Kubernetes cluster the operator can watch and manage. Here's a breakdown of the two main options:
	In the world of Kubernetes solutions, scope defines the reach of an projects's management capabilities. This essentially means deciding which resources across your Kubernetes cluster the manager can watch and manage. Here's a breakdown of the two main options:


		## Defaults and Considerations:

		- The operator-sdk init command by default creates a cluster-scoped operator.

	- The operator-sdk init command by default creates a cluster-scoped operator.
	- The kubebuilder init command by default creates a cluster-scoped project.

📖 Add Documentation for CRD and Operator Scope #3804

Are you sure you want to change the base?

📖 Add Documentation for CRD and Operator Scope #3804

Conversation

sarthaksarthak9 commented Mar 3, 2024

k8s-ci-robot commented Mar 3, 2024

k8s-ci-robot commented Mar 3, 2024

Choose a reason for hiding this comment

sarthaksarthak9 Apr 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 May 5, 2024 • edited

Choose a reason for hiding this comment

sarthaksarthak9 Apr 23, 2024 •

edited

camilamacedo86 May 5, 2024 •

edited