Skip to content

Commit 0b9fd9a

Browse files
authored
Merge pull request kubernetes#6539 from dminGod/patch-1
Spelling correction and sentence capitalization.
2 parents 0ca9deb + 47eed43 commit 0b9fd9a

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/concepts/api-extension/custom-resources.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,24 @@ When creating a new API, consider whether to [aggregate your API with the Kubern
4848
#### Declarative APIs
4949

5050
In a Declarative API, typically:
51-
- your API consists of a relatively small number of relatively small objects (resources).
52-
- the objects define configuration of applications or infrastructure
53-
- the objects are updated relatively infrequently
54-
- humans often need to read and write the objects
55-
- the main operations on the objects are CRUD-y (creating, reading, updating and deleting)
56-
- transactions across objects are not required: the API represents a desired state, not an exact state.
51+
- Your API consists of a relatively small number of relatively small objects (resources).
52+
- The objects define configuration of applications or infrastructure.
53+
- The objects are updated relatively infrequently.
54+
- Humans often need to read and write the objects.
55+
- The main operations on the objects are CRUD-y (creating, reading, updating and deleting).
56+
- Transactions across objects are not required: the API represents a desired state, not an exact state.
5757

5858
Imperative APIs are not declarative.
5959
Signs that your API might not be declarative include:
60-
- the client says "do this", and then gets a synchornous response back when it is done.
61-
- the client says "do this", and then gets an operation ID back, and has to check a separate Operation objects to determine completion of the request.
62-
- you talk about Remote Procedure Calls (RPCs)
63-
- directly stoing large amounts of data (e.g. > a few kB per object, or >1000s of objects)
64-
- high bandwidth access (10s of requests per second sustained) needed
65-
- store end-user data (such as images, PII, etc) or other large-scale data processed by applications
66-
- the natural operations on the objects are not CRUD-y.
67-
- the API is not easily modeled as objects.
68-
- you chose to represent pending operations with an operation ID or operation object.
60+
- The client says "do this", and then gets a synchornous response back when it is done.
61+
- The client says "do this", and then gets an operation ID back, and has to check a separate Operation objects to determine completion of the request.
62+
- You talk about Remote Procedure Calls (RPCs).
63+
- Directly storing large amounts of data (e.g. > a few kB per object, or >1000s of objects).
64+
- High bandwidth access (10s of requests per second sustained) needed.
65+
- Store end-user data (such as images, PII, etc) or other large-scale data processed by applications.
66+
- The natural operations on the objects are not CRUD-y.
67+
- The API is not easily modeled as objects.
68+
- You chose to represent pending operations with an operation ID or operation object.
6969

7070
### Should I use a configMap or a custom resource?
7171

@@ -102,7 +102,7 @@ Aggregated APIs are subordinate APIServers that sit behind the primary API serve
102102

103103
Custom Resource Definitions (CRDS) allow users to create new types of resources without adding another APIserver. You do not need to understand API Aggregation to use CRDs.
104104

105-
Regardless of whether they are installed via CRDs or AA, the new resources are called Custom Resources to distinguish them from built-in Kubernetes resources (like pods)
105+
Regardless of whether they are installed via CRDs or AA, the new resources are called Custom Resources to distinguish them from built-in Kubernetes resources (like pods).
106106

107107
## CustomResourceDefinitions
108108

@@ -215,9 +215,9 @@ Kubernetes [client libraries](/docs/reference/client-libraries/) can be used to
215215

216216
When you add a custom resource, you can access it using:
217217
- kubectl
218-
- the kubernetes dynamic client
219-
- a REST client that you write
220-
- a client generated using Kubernetes client generation tools (generating one is an advanced undertaking, but some projects may provide a client along with the CRD or AA).
218+
- The kubernetes dynamic client.
219+
- A REST client that you write.
220+
- A client generated using Kubernetes client generation tools (generating one is an advanced undertaking, but some projects may provide a client along with the CRD or AA).
221221

222222
{% endcapture %}
223223

0 commit comments

Comments
 (0)