Skip to content

Commit 3c7d940

Browse files
authored
replace quotes with backticks when referring to values (#2687)
1 parent e2f9936 commit 3c7d940

File tree

6 files changed

+126
-136
lines changed

6 files changed

+126
-136
lines changed

security/v1/authorization_policy.pb.go

Lines changed: 21 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

security/v1/authorization_policy.pb.html

Lines changed: 21 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

security/v1/authorization_policy.proto

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,20 @@ import "type/v1beta1/selector.proto";
4646
//
4747
// Here is an example of Istio Authorization Policy:
4848
//
49-
// It sets the `action` to "ALLOW" to create an allow policy. The default action is "ALLOW"
49+
// It sets the `action` to `ALLOW` to create an allow policy. The default action is `ALLOW`
5050
// but it is useful to be explicit in the policy.
5151
//
5252
// It allows requests from:
5353
//
54-
// - service account "cluster.local/ns/default/sa/sleep" or
55-
// - namespace "test"
54+
// - service account `cluster.local/ns/default/sa/sleep` or
55+
// - namespace `test`
5656
//
5757
// to access the workload with:
5858
//
59-
// - "GET" method at paths of prefix "/info" or,
60-
// - "POST" method at path "/data".
59+
// - `GET` method at paths of prefix `/info` or,
60+
// - `POST` method at path `/data`.
6161
//
62-
// when the request has a valid JWT token issued by "https://accounts.google.com".
62+
// when the request has a valid JWT token issued by `https://accounts.google.com`.
6363
//
6464
// Any other requests will be denied.
6565
//
@@ -89,9 +89,9 @@ import "type/v1beta1/selector.proto";
8989
// values: ["https://accounts.google.com"]
9090
// ```
9191
//
92-
// The following is another example that sets `action` to "DENY" to create a deny policy.
93-
// It denies requests from the "dev" namespace to the "POST" method on all workloads
94-
// in the "foo" namespace.
92+
// The following is another example that sets `action` to `DENY` to create a deny policy.
93+
// It denies requests from the `dev` namespace to the `POST` method on all workloads
94+
// in the `foo` namespace.
9595
//
9696
// ```yaml
9797
// apiVersion: security.istio.io/v1
@@ -111,7 +111,7 @@ import "type/v1beta1/selector.proto";
111111
// ```
112112
//
113113
// The following is another example that sets `action` to `DENY` to create a deny policy.
114-
// It denies all the requests with "POST" method on port "8080" on all workloads
114+
// It denies all the requests with `POST` method on port `8080` on all workloads
115115
// in the `foo` namespace.
116116
//
117117
// ```yaml
@@ -130,12 +130,12 @@ import "type/v1beta1/selector.proto";
130130
// ```
131131
//
132132
// When this rule is applied to TCP traffic, the `method` field (as will all HTTP based attributes) cannot be processed.
133-
// For a `DENY` rule, missing attributes are treated as matches. This means all TCP traffic on port 8080 would be denied in the example above.
133+
// For a `DENY` rule, missing attributes are treated as matches. This means all TCP traffic on port `8080` would be denied in the example above.
134134
// If we were to remove the `ports` match, all TCP traffic would be denied. As a result, it is recommended to always scope `DENY` policies to a specific port,
135135
// especially when using HTTP attributes [Authorization Policy for TCP Ports](https://istio.io/latest/docs/tasks/security/authorization/authz-tcp/).
136136
//
137-
// The following authorization policy sets the `action` to "AUDIT". It will audit any GET requests to the path with the
138-
// prefix "/user/profile".
137+
// The following authorization policy sets the `action` to `AUDIT`. It will audit any GET requests to the path with the
138+
// prefix `/user/profile`.
139139
//
140140
// ```yaml
141141
// apiVersion: security.istio.io/v1
@@ -156,16 +156,14 @@ import "type/v1beta1/selector.proto";
156156
// ```
157157
//
158158
// Authorization Policy scope (target) is determined by "metadata/namespace" and
159-
// an optional "selector".
159+
// an optional `selector`.
160160
//
161161
// - "metadata/namespace" tells which namespace the policy applies. If set to root
162162
// namespace, the policy applies to all namespaces in a mesh.
163-
// - workload "selector" can be used to further restrict where a policy applies.
164-
//
165-
// For example,
163+
// - workload `selector` can be used to further restrict where a policy applies.
166164
//
167-
// The following authorization policy applies to all workloads in namespace foo. It allows nothing and effectively denies
168-
// all requests to workloads in namespace foo.
165+
// For example, the following authorization policy applies to all workloads in namespace `foo`. It allows nothing and effectively denies
166+
// all requests to workloads in namespace `foo`.
169167
//
170168
// ```yaml
171169
// apiVersion: security.istio.io/v1
@@ -177,7 +175,7 @@ import "type/v1beta1/selector.proto";
177175
// {}
178176
// ```
179177
//
180-
// The following authorization policy allows all requests to workloads in namespace foo.
178+
// The following authorization policy allows all requests to workloads in namespace `foo`.
181179
//
182180
// ```yaml
183181
// apiVersion: security.istio.io/v1
@@ -190,7 +188,7 @@ import "type/v1beta1/selector.proto";
190188
// - {}
191189
// ```
192190
//
193-
// The following authorization policy applies to workloads containing label "app: httpbin" in namespace bar. It allows
191+
// The following authorization policy applies to workloads containing label `app: httpbin` in namespace `bar`. It allows
194192
// nothing and effectively denies all requests to the selected workloads.
195193
//
196194
// ```yaml
@@ -205,8 +203,8 @@ import "type/v1beta1/selector.proto";
205203
// app: httpbin
206204
// ```
207205
//
208-
// The following authorization policy applies to workloads containing label "version: v1" in all namespaces in the mesh.
209-
// (Assuming the root namespace is configured to "istio-system").
206+
// The following authorization policy applies to workloads containing label `version: v1` in all namespaces in the mesh.
207+
// (Assuming the root namespace is configured to `istio-system`).
210208
//
211209
// ```yaml
212210
// apiVersion: security.istio.io/v1

0 commit comments

Comments
 (0)