Skip to content

Commit cb504f0

Browse files
Format markdown (#1123)
* Format markdown Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)` * Revert bad diff
1 parent 1c2a4f5 commit cb504f0

File tree

14 files changed

+171
-145
lines changed

14 files changed

+171
-145
lines changed

contributing/WORKING-GROUPS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@ API
6868

6969
[Build](https://github.com/knative/build), Builders, and Build templates
7070

71-
| Artifact | Link |
72-
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
73-
| Forum | [knative-dev@](https://groups.google.com/forum/#!forum/knative-dev) |
74-
| Community Meeting VC | [meet.google.com/hau-nwak-tgm](https://meet.google.com/hau-nwak-tgm) <br>Or dial in:<br>(US) +1 219-778-6103‬ PIN: ‪573 000‬# |
71+
| Artifact | Link |
72+
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
73+
| Forum | [knative-dev@](https://groups.google.com/forum/#!forum/knative-dev) |
74+
| Community Meeting VC | [meet.google.com/hau-nwak-tgm](https://meet.google.com/hau-nwak-tgm) <br>Or dial in:<br>(US) +1 219-778-6103‬ PIN: ‪573 000‬# |
7575
| Community Meeting Calendar | Every other Wednesday 10:00a-10:30a PST <br>[Calendar](https://calendar.google.com/event?action=TEMPLATE&tmeid=MTBkb3MwYnVrbDd0djE0a2kzcmpmbjZndm9fMjAxODA5MTJUMTcwMDAwWiBqYXNvbmhhbGxAZ29vZ2xlLmNvbQ&tmsrc=jasonhall%40google.com&scp=ALL) |
76-
| Meeting Notes | [Notes](https://docs.google.com/document/d/1e7gMVFlJfkFdTcaWj2qETeRD9kSBG2Vh8mASPmQMYC0/edit) |
77-
| Document Folder | [Folder](https://drive.google.com/corp/drive/folders/1ov16HvPam-v_FXAGEaUdHok6_hUAoIoe) |
78-
| Slack Channel | [#build-crd](https://knative.slack.com/messages/build-crd) |
76+
| Meeting Notes | [Notes](https://docs.google.com/document/d/1e7gMVFlJfkFdTcaWj2qETeRD9kSBG2Vh8mASPmQMYC0/edit) |
77+
| Document Folder | [Folder](https://drive.google.com/corp/drive/folders/1ov16HvPam-v_FXAGEaUdHok6_hUAoIoe) |
78+
| Slack Channel | [#build-crd](https://knative.slack.com/messages/build-crd) |
7979

8080
| &nbsp; | Leads | Company | Profile |
8181
| -------------------------------------------------------- | ---------- | ------- | --------------------------------------- |

docs/build/auth.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -209,14 +209,12 @@ credentials are then used to authenticate with the Docker registry.
209209
## Kubernetes's Docker registry's secret
210210

211211
Kubernetes defines two types of secrets for Docker registries :
212-
`kubernetes.io/dockercfg` and
213-
`kubernetes.io/dockerconfigjson`. Knative supports those secrets in
214-
addition to the one described above.
215-
216-
1. Define a `Secret` from a Docker client configuration file, as
217-
documented in [Pull an Image from a Private
218-
Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)
219-
212+
`kubernetes.io/dockercfg` and `kubernetes.io/dockerconfigjson`. Knative supports
213+
those secrets in addition to the one described above.
214+
215+
1. Define a `Secret` from a Docker client configuration file, as documented in
216+
[Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)
217+
220218
```bash
221219
kubectl create secret generic regcred \
222220
--from-file=.dockerconfigjson=<path/to/.docker/config.json> \
@@ -225,42 +223,42 @@ addition to the one described above.
225223

226224
1. Direct a `ServiceAccount` to use this `Secret`:
227225

228-
```yaml
229-
apiVersion: v1
230-
kind: ServiceAccount
231-
metadata:
232-
name: build-bot
233-
secrets:
234-
- name: regcred
235-
```
236-
237-
1. Use that `ServiceAccount` in your `Build`:
226+
```yaml
227+
apiVersion: v1
228+
kind: ServiceAccount
229+
metadata:
230+
name: build-bot
231+
secrets:
232+
- name: regcred
233+
```
238234

239-
```yaml
240-
apiVersion: build.knative.dev/v1alpha1
241-
kind: Build
242-
metadata:
243-
name: build-with-basic-auth
244-
spec:
245-
serviceAccountName: build-bot
246-
steps:
247-
...
248-
```
235+
1. Use that `ServiceAccount` in your `Build`:
236+
237+
```yaml
238+
apiVersion: build.knative.dev/v1alpha1
239+
kind: Build
240+
metadata:
241+
name: build-with-basic-auth
242+
spec:
243+
serviceAccountName: build-bot
244+
steps:
245+
...
246+
```
249247

250-
1. Execute the build:
248+
1. Execute the build:
251249

252-
```shell
253-
kubectl apply --filename secret.yaml --filename serviceaccount.yaml --filename build.yaml
254-
```
250+
```shell
251+
kubectl apply --filename secret.yaml --filename serviceaccount.yaml --filename build.yaml
252+
```
255253

256254
When this build executes, before steps execute, a `~/.docker/config.json` will
257255
be generated containing the credentials configured in the `Secret`, and these
258256
credentials are then used to authenticate with the Docker registry.
259257

260-
If both `kubernetes.io/*` and knative flavored basic authentication
261-
secret are provided, knative will merge the credentials from those
262-
two ; knative flavored credentials taking precendence over
263-
`kubernetes.io/dockerconfigjson` (or `kubernetes.io/dockercfg`) ones.
258+
If both `kubernetes.io/*` and knative flavored basic authentication secret are
259+
provided, knative will merge the credentials from those two ; knative flavored
260+
credentials taking precendence over `kubernetes.io/dockerconfigjson` (or
261+
`kubernetes.io/dockercfg`) ones.
264262

265263
### Guiding credential selection
266264

docs/eventing/README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -258,33 +258,49 @@ See the [Cronjob Source](samples/cronjob-source) example.
258258

259259
### KafkaSource
260260

261-
The KafkaSource reads events from an Apache Kafka Cluster, and passes these to a Knative Serving application so that they can be consumed.
261+
The KafkaSource reads events from an Apache Kafka Cluster, and passes these to a
262+
Knative Serving application so that they can be consumed.
262263

263264
**Spec fields**:
264265

265266
- `consumerGroup`: `string` Name of a Kafka consumer group.
266-
- `bootstrapServers`: `string` Comma separated list of `hostname:port` pairs for the Kafka Broker.
267+
- `bootstrapServers`: `string` Comma separated list of `hostname:port` pairs for
268+
the Kafka Broker.
267269
- `topics`: `string` Name of the Kafka topic to consume messages from.
268270

269-
See the [Kafka Source](https://github.com/knative/eventing-sources/tree/master/contrib/kafka/samples) example.
271+
See the
272+
[Kafka Source](https://github.com/knative/eventing-sources/tree/master/contrib/kafka/samples)
273+
example.
270274

271275
### CamelSource
272276

273-
A CamelSource is an event source that can represent any existing [Apache Camel component](https://github.com/apache/camel/tree/master/components) that provides a consumer side, and enables publishing events to an addressable endpoint. Each Camel endpoint has the form of a URI where the scheme is the ID of the component to use.
277+
A CamelSource is an event source that can represent any existing
278+
[Apache Camel component](https://github.com/apache/camel/tree/master/components)
279+
that provides a consumer side, and enables publishing events to an addressable
280+
endpoint. Each Camel endpoint has the form of a URI where the scheme is the ID
281+
of the component to use.
274282

275-
CamelSource requires [Camel-K](https://github.com/apache/camel-k#installation) to be installed into the current namespace.
283+
CamelSource requires [Camel-K](https://github.com/apache/camel-k#installation)
284+
to be installed into the current namespace.
276285

277286
**Spec fields**:
278287

279288
- source: information on the kind of Camel source that should be created.
280-
- component: the default kind of source, enables creating an EventSource by configuring a single Camel component.
281-
- uri: `string` contains the Camel URI that should be used to push events into the target sink.
282-
- properties: `key/value map` contains Camel global options or component specific configuration. Options are available in the documentation of each existing Apache Camel component.
283-
- serviceAccountName: `string` an optional service account that can be used to run the source pod.
284-
- image: `string` an optional base image to use for the source pod, mainly for development purposes.
285-
286-
See the [CamelSource](https://github.com/knative/eventing-sources/blob/master/contrib/camel/samples/README.md) example.
287-
289+
- component: the default kind of source, enables creating an EventSource by
290+
configuring a single Camel component.
291+
- uri: `string` contains the Camel URI that should be used to push events
292+
into the target sink.
293+
- properties: `key/value map` contains Camel global options or component
294+
specific configuration. Options are available in the documentation of each
295+
existing Apache Camel component.
296+
- serviceAccountName: `string` an optional service account that can be used to
297+
run the source pod.
298+
- image: `string` an optional base image to use for the source pod, mainly for
299+
development purposes.
300+
301+
See the
302+
[CamelSource](https://github.com/knative/eventing-sources/blob/master/contrib/camel/samples/README.md)
303+
example.
288304

289305
## Getting Started
290306

docs/eventing/samples/cronjob-source/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ kail -l serving.knative.dev/service=message-dumper -c user-container --since=10m
9696
### Cleanup
9797

9898
You can remove the Cron Event Source via:
99+
99100
```shell
100101
kubectl delete --filename cronjob-source.yaml
101102
```

docs/eventing/samples/iot-core/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,19 +204,22 @@ see them in the subscriber.
204204
To cleanup the knative resources:
205205

206206
1. Remove the gcppubsub controller:
207+
207208
```shell
208209
pushd $HOME/go/src/github.com/knative/eventing-sources
209210
kubectl delete --filename config/default-gcppubsub.yaml
210211
popd
211212
```
212213

213214
2. Remove the channel:
215+
214216
```shell
215217
sed "s/CHANNEL_NAME/$CHANNEL_NAME/" channel.yaml |
216218
kubectl --namespace default delete --filename -
217219
```
218220

219221
3. Remove the gcppubsub source:
222+
220223
```shell
221224
sed -e "s/MY_GCP_PROJECT/$IOTCORE_PROJECT/" \
222225
-e "s/TOPIC_NAME/$IOTCORE_TOPIC_DATA/" \

docs/eventing/samples/kubernetes-event-source/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@ Ce-Source: /apis/v1/namespaces/default/pods/busybox
9595

9696
### Cleanup
9797

98-
You can remove the `Channel`, `Service Account`, `Event Sources`, and `Subscriber` via:
98+
You can remove the `Channel`, `Service Account`, `Event Sources`, and
99+
`Subscriber` via:
100+
99101
```shell
100102
kubectl --namespace default delete --filename channel.yaml
101103
kubectl --namespace default delete --filename serviceaccount.yaml

0 commit comments

Comments
 (0)