Skip to content

Commit 861182f

Browse files
committed
faq: typos and style/clarity suggestions
1 parent 6a3b391 commit 861182f

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

  • documentation/modules/ROOT/pages

documentation/modules/ROOT/pages/faq.adoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,20 @@ curl -H "Host:greeter.knativetutorial.example.com" $IP_ADDRESS
2828

2929
.Tag Digest
3030
***
31-
> Docker images wit v2 or later format has content addressable identifier called digest. The digest remains unchanged as long the underlying image content remains unchanged.
31+
> Docker images with v2 or later format have a content-addressable identifier called a `digest`. The digest is a hash of the image content, so images with the same digest are guaranteed to have idetical content.
3232
[.text-right]
3333
__**Source**: https://docs.docker.com/engine/reference/commandline/images/#list-image-digests__
3434

3535
***
3636

37-
Let say you have a deployment like the following (note that resource definition have been trimmed for brevity):
37+
Given a deployment like the following (note that resource definitions have been trimmed for brevity):
3838

3939
[source,yaml,linenums]
4040
----
4141
apiVersion: apps/v1
4242
kind: Deployment
4343
metadata:
44-
name: helloworld
44+
name: helloworld
4545
spec:
4646
template:
4747
spec:
@@ -59,20 +59,19 @@ When you deploy this application in kubernetes, the deployment will look like:
5959
apiVersion: apps/v1
6060
kind: Deployment
6161
metadata:
62-
name: helloworld
62+
name: helloworld
6363
spec:
6464
template:
6565
spec:
6666
containers:
6767
- name: my-container
68-
image: >-
69-
gcr.io/knative-samples/helloworld-go@sha256:98af362ceca8191277206b3b3854220ce125924b28a1166126296982e33882d0
68+
image: gcr.io/knative-samples/helloworld-go@sha256:98af362ceca8191277206b3b3854220ce125924b28a1166126296982e33882d0
7069
. . .
7170
----
7271

73-
In the above example the container image name of the deployment i.e. gcr.io/knative-samples/helloworld-go was resolved to its digest gcr.io/knative-samples/helloworld-go@sha256:98af362ceca8191277206b3b3854220ce125924b28a1166126296982e33882d0. Kubernetes extracts the digest from the image manifest. This process of resolving image tag to its digest is informally called as “Tag to Digest”.
72+
The container image name `gcr.io/knative-samples/helloworld-go` was resolved to its digest `gcr.io/knative-samples/helloworld-go@sha256:98af362ceca8191277206b3b3854220ce125924b28a1166126296982e33882d0`. Kubernetes extracts the digest from the image manifest. This process of resolving image tag to its digest is informally called as “Tag to Digest”.
7473

75-
Knative Serving deployments by default resolve the container images to digest during the deployment process. Knative Serving has been configured to skip the resolution of image name/tag to image digest for registries ko.local and dev.local, which can be used for local development builds, as the underlying image content are subject to changes during the development process.
74+
Knative Serving deployments, by default, resolve the container images to digest during the deployment process. Knative Serving has been configured to skip the resolution of image name/tag to image digest for registries ko.local and dev.local, which can be used for local development builds where the underlying image contents are subject to change during the development process.
7675

7776
[TIP]
7877
====
@@ -83,10 +82,10 @@ The following command shows an example how to add a registry **my.docker.registr
8382
```
8483
val=$(oc -n knative-serving get cm config-controller -oyaml | yq r - data.registriesSkippingTagResolving | awk '{print $1",my.docker.registry"}')
8584
86-
oc -n knative-serving get cm config-controller -oyaml | yq w - data.registriesSkippingTagResolving $val | oc apply -f -
85+
oc -n knative-serving get cm config-controller -oyaml | yq w - data.registriesSkippingTagResolving $val | oc apply -f -
8786
```
8887
====
8988

9089
[#faq-q3]
91-
== What is revision simpler terms?
92-
In Knative serving, things are driven via a https://github.com/knative/serving/blob/master/docs/spec/spec.md#configuration[Configuration] to make a separation between code (container images) and config. One of the good practices in configuration management is that we should always be able to rollback the application state to any “last known good configuration”, to be able to allow this type of rollback Knative creates an unique revision for each and every configuration change.
90+
== What is a "revision" in simpler terms?
91+
A https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision[Revision] is an immutable snapshot of code and configuration. Each change to an application's https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration[Configuration] creates a new *Revision*, which allows an application to be rolled back to any previous “known good configuration”.

0 commit comments

Comments
 (0)