Skip to content

Commit 7b21c4b

Browse files
authored
docs: formatting fixes in WasmPlugin (#3070)
Signed-off-by: Peter Jausovec <[email protected]>
1 parent 9911a0a commit 7b21c4b

File tree

4 files changed

+46
-46
lines changed

4 files changed

+46
-46
lines changed

extensions/v1alpha1/wasm.pb.go

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

extensions/v1alpha1/wasm.pb.html

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

extensions/v1alpha1/wasm.proto

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -243,24 +243,24 @@ message WasmPlugin {
243243
// namespace, it will be applied to all applicable workloads in any
244244
// namespace.
245245
//
246-
// At most, only one of the selector or targetRef can be set for a given policy.
246+
// At most, only one of the selector or `targetRef` can be set for a given policy.
247247
istio.type.v1beta1.WorkloadSelector selector = 1;
248248

249-
// Optional. The targetRef specifies the gateway the policy should be
249+
// Optional. The `targetRef` specifies the gateway the policy should be
250250
// applied to. The targeted resource specified will determine which
251251
// workloads the WasmPlugin applies to. The targeted resource must be
252252
// a `Gateway` in the group `gateway.networking.k8s.io`. The gateway
253253
// must be in the same namespace as the policy.
254254
//
255255
// If the `targetRef` is not set, the policy is applied as defined by the selector.
256-
// At most, only one of the selector or targetRef can be set for a given policy.
256+
// At most, only one of the selector or `targetRef` can be set for a given policy.
257257
// Waypoint proxies will not respect selectors even if they match.
258258
istio.type.v1beta1.PolicyTargetReference targetRef = 15;
259259

260260
// URL of a Wasm module or OCI container. If no scheme is present,
261261
// defaults to `oci://`, referencing an OCI image. Other valid schemes
262262
// are `file://` for referencing .wasm module files present locally
263-
// within the proxy container, and `http[s]://` for .wasm module files
263+
// within the proxy container, and `http[s]://` for `.wasm` module files
264264
// hosted remotely.
265265
// +kubebuilder:validation:MinLength=1
266266
// +kubebuilder:validation:XValidation:message="url must have schema one of [http, https, file, oci]",rule="isURL(self) ? (url(self).getScheme() in ['', 'http', 'https', 'oci', 'file']) : (isURL('http://' + self) && url('http://' +self).getScheme() in ['', 'http', 'https', 'oci', 'file'])"
@@ -275,16 +275,16 @@ message WasmPlugin {
275275
string sha256 = 3;
276276

277277
// The pull behaviour to be applied when fetching Wasm module by either
278-
// OCI image or http/https. Only relevant when referencing Wasm module without
279-
// any digest, including the digest in OCI image URL or sha256 field in `vm_config`.
280-
// Defaults to IfNotPresent, except when an OCI image is referenced in the `url`
278+
// OCI image or `http/https`. Only relevant when referencing Wasm module without
279+
// any digest, including the digest in OCI image URL or `sha256` field in `vm_config`.
280+
// Defaults to `IfNotPresent`, except when an OCI image is referenced in the `url`
281281
// and the `latest` tag is used, in which case `Always` is the default,
282-
// mirroring K8s behaviour.
282+
// mirroring Kubernetes behaviour.
283283
PullPolicy image_pull_policy = 4;
284284

285285
// Credentials to use for OCI image pulling.
286-
// Name of a K8s Secret in the same namespace as the `WasmPlugin` that
287-
// contains a docker pull secret which is to be used to authenticate
286+
// Name of a Kubernetes Secret in the same namespace as the `WasmPlugin` that
287+
// contains a Docker pull secret which is to be used to authenticate
288288
// against the registry when pulling the image.
289289
// +kubebuilder:validation:MinLength=1
290290
// +kubebuilder:validation:MaxLength=253
@@ -346,10 +346,10 @@ message WasmPlugin {
346346
// traffic will be selected.
347347
message TrafficSelector {
348348
// Criteria for selecting traffic by their direction.
349-
// Note that CLIENT and SERVER are analogous to OUTBOUND and INBOUND,
349+
// Note that `CLIENT` and `SERVER` are analogous to OUTBOUND and INBOUND,
350350
// respectively.
351-
// For the gateway, the field should be CLIENT or CLIENT_AND_SERVER.
352-
// If not specified, the default value is CLIENT_AND_SERVER.
351+
// For the gateway, the field should be `CLIENT` or `CLIENT_AND_SERVER`.
352+
// If not specified, the default value is `CLIENT_AND_SERVER`.
353353
istio.type.v1beta1.WorkloadMode mode = 1;
354354

355355
// Criteria for selecting traffic by their destination port.
@@ -423,8 +423,8 @@ enum PluginPhase {
423423
// buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE
424424
// -->
425425
enum PullPolicy {
426-
// Defaults to IfNotPresent, except for OCI images with tag `latest`, for which
427-
// the default will be Always.
426+
// Defaults to `IfNotPresent`, except for OCI images with tag `latest`, for which
427+
// the default will be `Always`.
428428
UNSPECIFIED_POLICY = 0;
429429

430430
// If an existing version of the image has been pulled before, that

kubernetes/customresourcedefinitions.gen.yaml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)