Skip to content

Commit ea8204b

Browse files
committed
Fixes for the spelling, broken links and such issues
1 parent 8b34f6c commit ea8204b

10 files changed

Lines changed: 28 additions & 53 deletions

File tree

documentation/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
** xref:04-scaling.adoc#scaling-invoke-service[Invoke Service]
4444
** xref:04-scaling.adoc#scaling-scale-to-zero[Scale to Zero]
4545
*** xref:04-scaling.adoc#scaling-observer-scale-to-zero[Observing default scale down ]
46-
*** xref:04-scaling.adoc#scaling-observer-scale-to-zero-1m[Change scale to zero time]
46+
*** xref:04-scaling.adoc#scaling-observer-scale-to-zero-1m[Change scale-to-zero time]
4747
*** xref:04-scaling.adoc#scaling-reset-to-defaults[Reset to Defaults]
4848
** xref:04-scaling.adoc#scaling-auto-scaling[Auto Scaling]
4949
*** xref:04-scaling.adoc#scaling-autoscaling-deploy-service[Deploy Service]

documentation/modules/ROOT/pages/01-setup.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ The following CLI tools are required for running the exercises in this tutorial.
1919
| https://github.com/minishift/minishift/releases
2020
|
2121

22+
| `git`
23+
| https://git-scm.com/download/mac
24+
| dnf install git
25+
|
26+
2227
| https://maven.apache.org[Apache Maven]
2328
| `brew install maven`
2429
| `dnf install maven`

documentation/modules/ROOT/pages/03-configs-and-routes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ include::partial$build-containers.adoc[tag=greeter]
2020

2121
In the previous chapter we saw how we can deploy services using a holistic service resource file, in this chapter we will see how to deploy the service using configurations and route files.
2222

23-
Navigate to the tutorial chapter's `knative` folder:
23+
Navigate to the tutorial chapter's folder:
2424

2525
[source,bash,subs="+macros,+attributes"]
2626
----

documentation/modules/ROOT/pages/04-scaling.adoc

Lines changed: 12 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The last `curl` command should return a response like **Hi greeter => greeter-00
8686
Check <<02-basic-fundas.adoc#see-what-you-have-deployed,deployed Knative resources>> for more details on which Knative objects and resources have been created with the service deployment above.
8787

8888
[#scaling-scale-to-zero]
89-
== Configure scale to zero
89+
== Configure scale-to-zero
9090

9191
Assuming that <<scaling-deploy-service, Greeter service>> has been deployed, once no more traffic is seen going into that service, we'd like to scale this service down to zero replicas. That's called **scale-to-zero**.
9292

@@ -95,7 +95,7 @@ Scale-to-zero is one of the main properties making Knative a serverless platform
9595
If another request tries to get to this revision, the activator will get it, instruct the autoscaler to create new pods for the revision as quickly as possible and buffer the request until those new pods are created.
9696

9797
[#scale-to-zero-formulae]
98-
=== Calculating scale to zero time period
98+
=== Calculating scale-to-zero time period
9999

100100
The Knative autoscaler uses the config map **config-autoscaler** in the **knative-serving** namespace for autoscaling related properties. The values of the attribute `stable-window` and `scale-to-zero-grace-period`, which we've seen above, are part of this config map.
101101

@@ -131,6 +131,13 @@ As described above, the time it takes to finally scale to zero will be `STABLE_W
131131

132132
For easier observation let us open a new terminal and run the following command,
133133

134+
[source,bash,subs="+macros,+attributes"]
135+
----
136+
watch 'kubectl get pods -n knativetutorial'
137+
----
138+
139+
.(OR)
140+
134141
[source,bash,subs="+macros,+attributes"]
135142
----
136143
watch 'oc get pods -n knativetutorial'
@@ -147,7 +154,7 @@ echo $STABLE_WINDOW
147154
echo $SCALE_TO_ZERO_GRACE_PERIOD
148155
----
149156

150-
By default the **scale-to-zero-grace-period** is `30s`, and the **stable-window** is `60s`. Firing a request to the greeter service will bring up the pod (if it is already terminated, as described above) to serve the request. Leaving it without any further requests will automatically cause it to scale to zero in `1 min 30 secs`(<<scale-to-zero-formulae,Compute scale to zero grace period>>).
157+
By default the **scale-to-zero-grace-period** is `30s`, and the **stable-window** is `60s`. Firing a request to the greeter service will bring up the pod (if it is already terminated, as described above) to serve the request. Leaving it without any further requests will automatically cause it to scale to zero in `1 min 30 secs`(<<scale-to-zero-formulae,Compute scale-to-zero grace period>>).
151158

152159
[#scaling-observer-scale-to-zero-1m]
153160
=== Scale to zero in 1 minute
@@ -189,47 +196,10 @@ oc -n knative-serving get configmap config-autoscaler -o yaml \
189196
| yq r - data.scale-to-zero-grace-period
190197
----
191198

192-
Now <<scaling-invoke-service,firing the request>> to the greeter service will bring up the pod to serve the request again. Leaving it without any further requests, it will automatically scale to zero in `2 mins`(<<scale-to-zero-formulae,Compute scale to zero grace period>>)
193-
194-
[#scaling-observer-scale-to-zero-2m]
195-
=== Scale to zero in 2 minute
196-
197-
Let us now update **scale-to-zero-grace-period** to `2m` and leave the **stable-window** to default `60s`.
198-
199-
[source,bash,subs="+macros,+attributes"]
200-
----
201-
kubectl -n knative-serving get cm config-autoscaler -o yaml | yq w - -s link:{github-repo}/{scaling-repo}/knative/configure-scaling-to-2m.yaml[configure-scaling-to-2m.yaml] | kubectl apply -f -
202-
----
203-
204-
.(OR)
205-
206-
[source,bash,subs="+macros,+attributes"]
207-
----
208-
oc -n knative-serving get cm config-autoscaler -o yaml | yq w - -s link:{github-repo}/{scaling-repo}/knative/configure-scaling-to-2m.yaml[configure-scaling-to-2m.yaml] | oc apply -f -
209-
----
210-
211-
Verifying the `scale-to-zero-grace-period` value, which should return `2m`:
212-
213-
[source,bash,subs="+macros,+attributes",linenums]
214-
----
215-
216-
kubectl -n knative-serving get configmap config-autoscaler -o yaml \
217-
| yq r - data.scale-to-zero-grace-period
218-
----
219-
220-
.(OR)
221-
222-
[source,bash,subs="+macros,+attributes",linenums]
223-
----
224-
oc -n knative-serving get configmap config-autoscaler -o yaml \
225-
| yq r - data.scale-to-zero-grace-period
226-
----
227-
228-
229-
Now <<scaling-invoke-service,firing the request>> to the greeter service will bring up the pod to serve the request and if we leave the service without any further requests, it will automatically scale to zero in `3 mins`(<<scale-to-zero-formulae,Compute scale to zero grace period>>).
199+
Now <<scaling-invoke-service,firing the request>> to the greeter service will bring up the pod to serve the request again. Leaving it without any further requests, it will automatically scale to zero in `2 mins`(<<scale-to-zero-formulae,Compute scale-to-zero grace period>>)
230200

231201
[#scaling-reset-to-defaults]
232-
=== Reset scale to zero to defaults
202+
=== Reset scale-to-zero to defaults
233203

234204
Let us revert the `scale-to-zero-grace-period` to its default:
235205

documentation/modules/ROOT/pages/05-build/build-templates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,4 +279,4 @@ oc -n knativetutorial delete services.serving.knative.dev event-greeter
279279
oc -n knativetutorial delete buildtemplates.build.knative.dev build-java-maven
280280
----
281281

282-
NOTE: You can also delete xref:ROOT:05-build/build.adoc#build-apply-prereq-resources[pre-req resources] that were created if you dont need them any more.
282+
NOTE: You can also delete xref:ROOT:05-build/build.adoc#build-apply-prereq-resources[pre-req resources] that were created if you don't need them anymore.

documentation/modules/ROOT/pages/05-build/build.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ type: kubernetes.io/basic-auth
7272
<2> The username to use when authenticating with https://index.docker.io/v1/
7373
<3> The password to use when authenticating with https://index.docker.io/v1/
7474

75-
For more details on why we need to do this please check https://github.com/knative/docs/blob/master/build/auth.md#basic-authentication-docker[here].
75+
For more details on why we need to do this please check https://github.com/knative/docs/blob/master/docs/build/auth.md#basic-authentication-docker[here].
7676

7777
[#build-generate-build-spec]
7878
== Generate Knative build spec
79-
The knative build spec is used to create and run the knative builds. You can find more details on Knative build https://github.com/knative/docs/tree/master/build[here].
79+
The knative build spec is used to create and run the knative builds. You can find more details on Knative build https://github.com/knative/docs/tree/master/docs/build[here].
8080

8181
[source,bash,subs="+macros,+attributes",linenums]
8282
----
@@ -222,8 +222,8 @@ oc apply -n knativetutorial -f link:{github-repo}/{build-repo}/knative/kaniko-pv
222222
----
223223

224224

225-
<1> The kubernetes secret called `basic-auth-pass`, check https://github.com/knative/docs/blob/master/build/auth.md#basic-authentication-docker[here] for more details
226-
<2> The kubernetes service account called `build-bot` that wll run the build. Only `build-bot` as access to the secret `basic-auth-pass`. Check https://github.com/knative/docs/blob/master/build/auth.md#basic-authentication-docker[here] for more details
225+
<1> The kubernetes secret called `basic-auth-pass`, check https://github.com/knative/docs/blob/master/docs/build/auth.md#basic-authentication-docker[here] for more details
226+
<2> The kubernetes service account called `build-bot` that wll run the build. Only `build-bot` has access to the secret `basic-auth-pass`. Check https://github.com/knative/docs/blob/master/docs/build/auth.md#basic-authentication-docker[here] for more details
227227
<3> the kubernetes persistence volume claim used to cache maven artifacts, to make subsequent builds faster
228228
<4> the kubernetes persistence volume claim that will be used to cache docker base images to make subsequent https://github.com/GoogleContainerTools/kaniko[Kaniko] docker builds faster
229229

documentation/modules/ROOT/pages/06-eventing/eventing-src-sub.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,4 +353,4 @@ oc -n knativetutorial delete channels.eventing.knative.dev ch-event-greeter
353353
oc -n knativetutorial delete subscriptions.eventing.knative.dev event-greeter-subscriber
354354
----
355355

356-
NOTE: You can also delete xref:ROOT:05-build/build.adoc#build-apply-prereq-resources[pre-req resources] that were created if you dont need them any more.
356+
NOTE: You can also delete xref:ROOT:05-build/build.adoc#build-apply-prereq-resources[pre-req resources] that were created if you don't need them anymore.

documentation/modules/ROOT/pages/06-eventing/eventing-src-svc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,4 +213,4 @@ oc -n knativetutorial delete \
213213
cronjobsources.sources.eventing.knative.dev event-greeter-cronjob-source
214214
----
215215

216-
NOTE: You can also delete xref:ROOT:05-build/build.adoc#build-apply-prereq-resources[pre-req resources] that were created if you dont need them any more.
216+
NOTE: You can also delete xref:ROOT:05-build/build.adoc#build-apply-prereq-resources[pre-req resources] that were created if you don't need them anymore.

documentation/modules/ROOT/pages/06-eventing/eventing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ At the end of this chapter you will know and understand:
1414
include::partial$prereq-cli.adoc[]
1515

1616
[#eventing-assumptions]
17-
== Assumption
17+
== Assumptions
1818

1919
You have completed the xref:ROOT:05-build/build.adoc[Build] or xref:ROOT:05-build/build-templates.adoc[Build Templates], as you will be using the container image `event-greeter:0.0.1` or `event-greeter:0.0.2` in this chapter.
2020

documentation/modules/ROOT/pages/_partials/prereq-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ oc version
3636
[source,bash]
3737
----
3838
# right maven version Apache Maven 3.5.x or above
39-
./mvnw --version
39+
mvn --version
4040
----
4141

4242
* Make sure to be on `knativetutorial` OpenShift project/kubernetes namespace

0 commit comments

Comments
 (0)