Skip to content
This repository was archived by the owner on Jun 19, 2022. It is now read-only.

Commit ae3e41e

Browse files
authored
[master] Format markdown (#1478)
Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github | grep -v docs/cmd/)` /assign grantr ian-mi nachocano /cc grantr ian-mi nachocano
1 parent f29b055 commit ae3e41e

File tree

2 files changed

+34
-27
lines changed

2 files changed

+34
-27
lines changed

docs/install/dataplane-service-account.md

+30-25
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ In general, we would just need permissions to receive messages
2828
(`roles/pubsub.subscriber`). However, in the case of the `Channel`, we would
2929
also need the ability to publish messages (`roles/pubsub.publisher`).
3030

31-
1. Create a new Service Account named `cre-dataplane` with the following command:
31+
1. Create a new Service Account named `cre-dataplane` with the following
32+
command:
3233

3334
```shell
3435
gcloud iam service-accounts create cre-dataplane
@@ -46,21 +47,24 @@ also need the ability to publish messages (`roles/pubsub.publisher`).
4647
--member=serviceAccount:cre-dataplane@$PROJECT_ID.iam.gserviceaccount.com \
4748
--role roles/pubsub.editor
4849
```
49-
50-
***Note:***
51-
If you are going to use metrics and tracing to track your resources,
52-
you also need `roles/monitoring.metricWriter` for metrics functionality:
53-
```shell
54-
gcloud projects add-iam-policy-binding $PROJECT_ID \
55-
--member=serviceAccount:cre-dataplane@$PROJECT_ID.iam.gserviceaccount.com \
56-
--role roles/monitoring.metricWriter
57-
```
50+
51+
**_Note:_** If you are going to use metrics and tracing to track your
52+
resources, you also need `roles/monitoring.metricWriter` for metrics
53+
functionality:
54+
55+
```shell
56+
gcloud projects add-iam-policy-binding $PROJECT_ID \
57+
--member=serviceAccount:cre-dataplane@$PROJECT_ID.iam.gserviceaccount.com \
58+
--role roles/monitoring.metricWriter
59+
```
60+
5861
and `roles/cloudtrace.agent` for tracing functionality:
59-
```shell
60-
gcloud projects add-iam-policy-binding $PROJECT_ID \
61-
--member=serviceAccount:cre-dataplane@$PROJECT_ID.iam.gserviceaccount.com \
62-
--role roles/cloudtrace.agent
63-
```
62+
63+
```shell
64+
gcloud projects add-iam-policy-binding $PROJECT_ID \
65+
--member=serviceAccount:cre-dataplane@$PROJECT_ID.iam.gserviceaccount.com \
66+
--role roles/cloudtrace.agent
67+
```
6468

6569
## Configure the Authentication Mechanism for GCP (the Data Plane)
6670

@@ -86,7 +90,8 @@ Plane:
8690

8791
- **_Non-default scenario:_**
8892

89-
Using the Google Cloud Service Account `cre-dataplane` you just created and using
93+
Using the Google Cloud Service Account `cre-dataplane` you just created and
94+
using
9095
[Option 1 (Recommended): Workload Identity](../install/authentication-mechanisms-gcp.md/#option-1-recommended-workload-identity)
9196
in
9297
[Authentication Mechanism for GCP](../install/authentication-mechanisms-gcp.md)
@@ -97,9 +102,9 @@ Plane:
97102
configuration in the Control Plane)
98103

99104
You will have a Kubernetes Service Account after the above configuration,
100-
which is bound to the Google Cloud Service Account `cre-dataplane`. Remember to
101-
put this Kubernetes Service Account name as the `spec.serviceAccountName` when
102-
you create resources in the
105+
which is bound to the Google Cloud Service Account `cre-dataplane`. Remember
106+
to put this Kubernetes Service Account name as the `spec.serviceAccountName`
107+
when you create resources in the
103108
[example](https://github.com/google/knative-gcp/tree/master/docs/examples).
104109

105110
- **_Default scenario:_**
@@ -136,18 +141,18 @@ Plane:
136141
default-cre-dataplane: cre-dataplane@$PROJECT_ID.iam.gserviceaccount.com
137142
```
138143

139-
Here, `default-cre-dataplane` refers to a Kubernetes Service Account bound to the
140-
Google Cloud Service Account `cre-dataplane`. Remember to put this Kubernetes
141-
Service Account name as the `spec.serviceAccountName` when you create
142-
resources in the
144+
Here, `default-cre-dataplane` refers to a Kubernetes Service Account bound to
145+
the Google Cloud Service Account `cre-dataplane`. Remember to put this
146+
Kubernetes Service Account name as the `spec.serviceAccountName` when you
147+
create resources in the
143148
[example](https://github.com/google/knative-gcp/tree/master/docs/examples).
144149

145150
Kubernetes Service Account `default-cre-dataplane` doesn't need to exist in a
146151
specific namespace. Once it is set in the ConfigMap `config-gcp-auth`, the
147152
Control Plane will create it for you and configure the corresponding Workload
148153
Identity relationship between the Kubernetes Service Account
149-
`default-cre-dataplane` and the Google Cloud Service Account `cre-dataplane` when
150-
you create resources using the Kubernetes Service Account
154+
`default-cre-dataplane` and the Google Cloud Service Account `cre-dataplane`
155+
when you create resources using the Kubernetes Service Account
151156
`default-cre-dataplane`.
152157

153158
A `Condition` `WorkloadIdentityConfigured` will show up under resources'

docs/spec/pubsub-protocol-binding.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,8 @@ This example shows the _binary_ mode mapping of an event to a Pub/Sub Message:
183183
}
184184
```
185185

186-
This example show a publish request on the REST API of the above Pub/Sub Message:
186+
This example show a publish request on the REST API of the above Pub/Sub
187+
Message:
187188

188189
```text
189190
POST https://pubsub.googleapis.com/v1/{topic}:publish HTTP/1.1
@@ -266,7 +267,8 @@ Message:
266267
}
267268
```
268269

269-
This example show a publish request on the REST API of the above Pub/Sub Message:
270+
This example show a publish request on the REST API of the above Pub/Sub
271+
Message:
270272

271273
```text
272274
POST https://pubsub.googleapis.com/v1/{topic}:publish HTTP/1.1

0 commit comments

Comments
 (0)