Skip to content

Commit e2cafaf

Browse files
authored
Merge pull request #128 from hasbro17/haseeb/README-fix-typo
README: fix typos and remove redundancy
2 parents 85e8eef + b42dc1e commit e2cafaf

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ See the [design docs][design_docs] for planned work on upcoming milestones:
1010

1111
## Overview
1212

13-
[Operators][operator_link] make it easy to manage complex stateful applications on top of Kuberentes. However writing an operator today can be a significant effort that involves challenges like using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication.
13+
[Operators][operator_link] make it easy to manage complex stateful applications on top of Kubernetes. However writing an operator today can be a significant effort that involves challenges like using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication.
1414

1515
The Operator SDK is a framework designed to make writing operators easier by providing:
1616
- High level APIs and abstractions to write the operational logic more intuitively
@@ -21,7 +21,7 @@ The Operator SDK is a framework designed to make writing operators easier by pro
2121

2222
The SDK provides the following workflow to develop a new operator:
2323
1. Create a new operator project using the SDK Command Line Interface(CLI)
24-
2. Define new resource APIs by adding CRDs and specifying fields
24+
2. Define new resource APIs by adding Custom Resource Definitions(CRD)
2525
3. Specify resources to watch using the SDK API
2626
4. Define the operator reconciling logic in a designated handler and use the SDK API to interact with resources
2727
5. Use the SDK CLI to build and generate the operator deployment manifests
@@ -54,41 +54,41 @@ Before creating any project, this guide has the following prerequisites:
5454

5555
## Installing Operator SDK CLI
5656

57-
Operator SDK CLI tool is used to manage development lifecycle.
57+
The Operator SDK comes with a CLI tool that manages the development lifecycle. It helps create the project scaffolding, preprocess custom resource API to generate Kubernetes related code, and generate deployment scripts.
5858

5959
Checkout the desired release tag and install the SDK CLI tool:
6060
```
6161
git checkout tags/v0.0.1
6262
go install github.com/coreos/operator-sdk/commands/operator-sdk
6363
```
6464

65-
## Creating a new project
65+
This will install the CLI binary `operator-sdk` at `$GOPATH/bin`.
6666

67-
Operator SDK comes with a number of code generators that are designed to facilitate development lifecycle. It helps create the project scaffolding, preprocess custom resource API to generate Kubernetes related code, generate deployment scripts -- just everything that is necessary to build an operator.
67+
## Creating a new project
6868

6969
Navigate to `$GOPATH/src/github.com/example-inc/`.
7070

71-
To start a project, we use the `new` generator to provide the foundation of a fresh operator project. Run the following command:
71+
Use the `new` command to create a new operator project:
7272

7373
```
7474
operator-sdk new memcached-operator --api-version=cache.example.com/v1alpha1 --kind=Memcached
7575
```
7676

77-
This generates a project repo `memcached-operator`, a custom resource with APIVersion `cache.example.com/v1apha1` and Kind `Memcached`, and an example operator that watches all deployments in the same namespace and logs deployment names.
77+
This creates the project directory `memcached-operator` and generates the API pkg tree for a custom resource with APIVersion `cache.example.com/v1apha1` and Kind `Memcached`.
7878

7979
Navigate to the project folder:
8080

8181
```
8282
cd memcached-operator
8383
```
8484

85-
More details about the structure of the project can be found in [this doc][scaffold_doc].
85+
More details about the project directory structure can be found in the [project layout][scaffold_doc] doc.
8686

8787
## Up and running
8888

89-
At this step we actually have a functional operator already.
89+
At this point we are ready to build and run a functional operator.
9090

91-
The default operator behaviour as seen in the entrypoint `cmd/memcached-operator/main.go` is to watch for Deployments in the default namespace and print out their names.
91+
The default operator behaviour defined in the entry point `cmd/memcached-operator/main.go` is to watch for Deployments in the default namespace and print out their names.
9292

9393
> Note: This example watches Deployments for the APIVersion `apps/v1` which is only present in k8s versions 1.9+. So for k8s versions < 1.9 change the APIVersion to something that is supported e.g `apps/v1beta1`.
9494
@@ -101,22 +101,22 @@ docker push quay.io/example/memcached-operator:v0.0.1
101101

102102
Kubernetes deployment manifests are generated in `deploy/operator.yaml`. The deployment image is set to the container image specified above.
103103

104-
Deploy memcached-operator:
104+
Deploy the memcached-operator:
105105

106106
```
107107
kubectl create -f deploy/rbac.yaml
108108
kubectl create -f deploy/operator.yaml
109109
```
110110

111-
The memcached-operator would be up and running:
111+
Verify that the memcached-operator is up and running:
112112

113113
```
114114
$ kubectl get deploy
115115
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
116116
memcached-operator 1 1 1 1 1m
117117
```
118118

119-
Check memcached-operator pod’s log:
119+
Check the memcached-operator pod’s log:
120120

121121
```
122122
$ kubectl get pod | grep memcached-operator | cut -d' ' -f1 | xargs kubectl logs

0 commit comments

Comments
 (0)