Skip to content

Commit 576c198

Browse files
committed
Various docs fixes
1 parent e6aab8d commit 576c198

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# kubebuilder-declarative-pattern
22

3-
kubebuilder-declarative-pattern provides a set of tools for building declarative cluster operators with kubebuilder. Declarative operators provide a fast path to orchestrating Kubernetes deployments to enable domain experts to focus their component instead of re-answering questions like 'how do I get this YAML into the cluster?' or 'how do I update it?'.
3+
kubebuilder-declarative-pattern provides a set of tools for building declarative cluster operators with kubebuilder. Declarative operators provide a fast path to orchestrating Kubernetes deployments to enable domain experts to focus on their component instead of re-answering questions like 'How do I get this YAML into the cluster?' or 'How do I update it?'.
44

55
## Development
66

77
### Running Smoke Tests
88

9-
Smoke tests are provided to ensure basic functinality of the framework against example operators. They should be ran as part of significant code changes. The tests require a running Kubernetes cluster to be targeted from the local machine and write access to a GCR bucket.
9+
Smoke tests are provided to ensure basic functionality of the framework against example operators. They should be run as part of significant code changes. The tests require a running Kubernetes cluster to be targeted from the local machine and write access to a GCR bucket.
1010

1111
```bash
1212
cd hack

docs/addon/walkthrough/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ This walkthrough is for creating an operator to run the [guestbook](https://gith
77
Install the following depenencies:
88

99
- [kubebuilder](https://book.kubebuilder.io/quick-start.html#installation) (tested with 2.0.0-alpha.4)
10-
- [kustomize](https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md) (tested with v2.0.3)
10+
- [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) (tested with v2.0.3)
1111
- docker
1212
- kubectl
1313
- golang (>=1.11 for go modules)
1414

15-
Create a new directory and use kubebuilder to scafold the operator:
15+
Create a new directory and use kubebuilder to scaffold the operator:
1616

1717
```
1818
export GO111MODULE=on
@@ -53,7 +53,7 @@ when [server-side-apply](https://github.com/kubernetes/enhancements/issues/555)
5353
is available we'll use that.
5454

5555
We suggest that even advanced operators use a manifest for their core objects.
56-
It's always possible to manipulate the manifest before applying them (eg, adding labels,
56+
It's always possible to manipulate the manifest before applying it (eg, adding labels,
5757
changing namespaces, and tweaking flags)
5858

5959
Some other advantages:

docs/addon/walkthrough/tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ cp config/samples/* k8s/resources
150150
### Adding Tests
151151

152152
For this example, we will be adding a test for KubeDNS.
153-
All code changes will live in [smoketest.go](../../smoketest.go).
153+
All code changes will live in [smoketest.go](../../../hack/smoketest.go).
154154

155155
1. Create a test class that inherits from `CommonAddonsTest` and a constructor.
156156

0 commit comments

Comments
 (0)