Skip to content

Commit 7c93cbc

Browse files
committed
More OSSM attribute fixes in Serverless docs
1 parent 1212a5d commit 7c93cbc

7 files changed

+21
-21
lines changed

modules/serverless-ossm-enable-sidecar-injection-with-kourier.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can add the `sidecar.istio.io/inject="true"` annotation to a Knative service
1313
Adding sidecar injection to pods in system namespaces, such as `knative-serving` and `knative-serving-ingress`, is not supported when Kourier is enabled.
1414
1515
ifdef::openshift-enterprise[]
16-
If you require sidecar injection for pods in these namespaces, see the {ServerlessProductName} documentation on _Integrating {ProductShortName} with {ServerlessProductName} natively_.
16+
If you require sidecar injection for pods in these namespaces, see the {ServerlessProductName} documentation on _Integrating {SMProductShortName} with {ServerlessProductName} natively_.
1717
endif::[]
1818
====
1919

modules/serverlesss-ossm-external-certs.adoc renamed to modules/serverless-ossm-external-certs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="serverlesss-ossm-external-certs_{context}"]
77
= Creating a certificate to encrypt incoming external traffic
88

9-
By default, the {ProductShortName} mTLS feature only secures traffic inside of the {ProductShortName} itself, between the ingress gateway and individual pods that have sidecars. To encrypt traffic as it flows into the {product-title} cluster, you must generate a certificate before you enable the {ServerlessProductName} and {ProductShortName} integration.
9+
By default, the {SMProductShortName} mTLS feature only secures traffic inside of the {SMProductShortName} itself, between the ingress gateway and individual pods that have sidecars. To encrypt traffic as it flows into the {product-title} cluster, you must generate a certificate before you enable the {ServerlessProductName} and {SMProductShortName} integration.
1010

1111
.Prerequisites
1212

@@ -61,4 +61,4 @@ $ oc create -n istio-system secret tls wildcard-certs \
6161
--cert=wildcard.crt
6262
----
6363
+
64-
This certificate is picked up by the gateways created when you integrate {ServerlessProductName} with {ProductShortName}, so that the ingress gateway serves traffic with this certificate.
64+
This certificate is picked up by the gateways created when you integrate {ServerlessProductName} with {SMProductShortName}, so that the ingress gateway serves traffic with this certificate.

modules/serverless-ossm-setup-with-kourier.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-ossm-setup-with-kourier_{context}"]
7-
= Integrating {ProductShortName} with {ServerlessProductName} when Kourier is enabled
7+
= Integrating {SMProductShortName} with {ServerlessProductName} when Kourier is enabled
88

99
.Prerequisites
1010

@@ -23,7 +23,7 @@ endif::[]
2323
2424
.Procedure
2525

26-
. Add the namespaces that you would like to integrate with {ProductShortName} to the `ServiceMeshMemberRoll` object as members:
26+
. Add the namespaces that you would like to integrate with {SMProductShortName} to the `ServiceMeshMemberRoll` object as members:
2727
+
2828
[source,yaml]
2929
----
@@ -37,7 +37,7 @@ spec:
3737
- <namespace> <1>
3838
...
3939
----
40-
<1> A list of namespaces to be integrated with {ProductShortName}.
40+
<1> A list of namespaces to be integrated with {SMProductShortName}.
4141
. Apply the `ServiceMeshMemberRoll` resource:
4242
+
4343
[source,terminal]
@@ -58,7 +58,7 @@ $ oc label namespace knative-serving serving.knative.openshift.io/system-namespa
5858
----
5959
$ oc label namespace knative-serving-ingress serving.knative.openshift.io/system-namespace=true
6060
----
61-
.. For each namespace that you want to integrate with {ProductShortName}, create a `NetworkPolicy` resource:
61+
.. For each namespace that you want to integrate with {SMProductShortName}, create a `NetworkPolicy` resource:
6262
+
6363
[source,yaml]
6464
----
@@ -78,7 +78,7 @@ spec:
7878
- Ingress
7979
...
8080
----
81-
<1> Add the namespace that you want to integrate with {ProductShortName}.
81+
<1> Add the namespace that you want to integrate with {SMProductShortName}.
8282
.. Apply the `NetworkPolicy` resource:
8383
+
8484
[source,terminal]

modules/serverless-ossm-setup.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-ossm-setup_{context}"]
7-
= Integrating {ProductShortName} with {ServerlessProductName}
7+
= Integrating {SMProductShortName} with {ServerlessProductName}
88

9-
You can integrate {ProductShortName} with {ServerlessProductName} without using Kourier by completing the following procedure.
9+
You can integrate {SMProductShortName} with {ServerlessProductName} without using Kourier by completing the following procedure.
1010

1111
.Prerequisites
1212

@@ -24,7 +24,7 @@ endif::[]
2424
+
2525
[IMPORTANT]
2626
====
27-
Do not install the Knative Serving component before completing the following procedures. There are additional steps required when creating the `KnativeServing` custom resource defintion (CRD) to integrate Knative Serving with {ProductShortName}, which are not covered in the general Knative Serving installation procedure of the _Administration guide_.
27+
Do not install the Knative Serving component before completing the following procedures. There are additional steps required when creating the `KnativeServing` custom resource defintion (CRD) to integrate Knative Serving with {SMProductShortName}, which are not covered in the general Knative Serving installation procedure of the _Administration guide_.
2828
====
2929
* Install the OpenShift CLI (`oc`).
3030
* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
@@ -33,7 +33,7 @@ Do not install the Knative Serving component before completing the following pro
3333

3434
. Create a `ServiceMeshControlPlane` object in the `istio-system` namespace. If you want to use the mTLS functionality, this must be enabled for the `istio-system` namespace.
3535

36-
. Add the namespaces that you would like to integrate with {ProductShortName} to the `ServiceMeshMemberRoll` object as members:
36+
. Add the namespaces that you would like to integrate with {SMProductShortName} to the `ServiceMeshMemberRoll` object as members:
3737
+
3838
[source,yaml]
3939
----
@@ -47,7 +47,7 @@ spec:
4747
- knative-serving
4848
- <namespace>
4949
----
50-
<1> A list of namespaces to be integrated with {ProductShortName}.
50+
<1> A list of namespaces to be integrated with {SMProductShortName}.
5151
+
5252
[IMPORTANT]
5353
====
@@ -61,7 +61,7 @@ This list of namespaces must include the `knative-serving` namespace.
6161
$ oc apply -f <filename>
6262
----
6363

64-
. Create the necessary gateways so that {ProductShortName} can accept traffic:
64+
. Create the necessary gateways so that {SMProductShortName} can accept traffic:
6565
+
6666
.Example `knative-local-gateway` object using HTTP
6767
[source,yaml]
@@ -118,7 +118,7 @@ spec:
118118
targetPort: 8081
119119
----
120120
<1> Add the name of your wildcard certificate.
121-
<2> The `knative-local-gateway` serves HTTP traffic. Using HTTP means that traffic coming from outside of {ProductShortName}, but using an internal hostname, such as `example.default.svc.cluster.local`, is not encrypted. You can set up encryption for this path by creating another wildcard certificate and an additional gateway that uses a different `protocol` spec.
121+
<2> The `knative-local-gateway` serves HTTP traffic. Using HTTP means that traffic coming from outside of {SMProductShortName}, but using an internal hostname, such as `example.default.svc.cluster.local`, is not encrypted. You can set up encryption for this path by creating another wildcard certificate and an additional gateway that uses a different `protocol` spec.
122122
+
123123
.Example `knative-local-gateway` object using HTTPS
124124
[source,yaml]
@@ -206,7 +206,7 @@ spec:
206206
----
207207
<1> A namespace that is part of the Service Mesh member roll.
208208
<2> Instructs Knative Serving to generate an {product-title} pass-through enabled route, so that the certificates you have generated are served through the ingress gateway directly.
209-
<3> Injects {ProductShortName} sidecars into the Knative service pods.
209+
<3> Injects {SMProductShortName} sidecars into the Knative service pods.
210210
211211
. Apply the `Service` resource:
212212
+

modules/serverless-ossm-v1x-jwt.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-ossm-v1x-jwt_{context}"]
7-
= Using JSON Web Token authentication with {ProductShortName} 1.x and {ServerlessProductName}
7+
= Using JSON Web Token authentication with {SMProductShortName} 1.x and {ServerlessProductName}
88

9-
You can use the following procedure to enable using JSON Web Token authentication with {ProductShortName} 1.x and {ServerlessProductName}.
9+
You can use the following procedure to enable using JSON Web Token authentication with {SMProductShortName} 1.x and {ServerlessProductName}.
1010

1111
.Prerequisites
1212

modules/serverless-ossm-v2x-jwt.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-ossm-v2x-jwt_{context}"]
7-
= Using JSON Web Token authentication with {ProductShortName} 2.x and {ServerlessProductName}
7+
= Using JSON Web Token authentication with {SMProductShortName} 2.x and {ServerlessProductName}
88

9-
You can use the following procedure to enable using JSON Web Token authentication with {ProductShortName} 2.x and {ServerlessProductName}.
9+
You can use the following procedure to enable using JSON Web Token authentication with {SMProductShortName} 2.x and {ServerlessProductName}.
1010

1111
.Prerequisites
1212

serverless/admin_guide/serverless-ossm-setup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You must configure the wildcard certificate to match the domain of your {product
2929

3030
If you want to use any domain name, including those which are not subdomains of the default {product-title} cluster domain, you must set up domain mapping for those domains. For more information, see the {ServerlessProductName} documentation about xref:../../serverless/security/serverless-custom-domains.adoc#serverless-create-domain-mapping_serverless-custom-domains[Creating a custom domain mapping].
3131

32-
include::modules/serverlesss-ossm-external-certs.adoc[leveloffset=+2]
32+
include::modules/serverless-ossm-external-certs.adoc[leveloffset=+2]
3333
include::modules/serverless-ossm-setup.adoc[leveloffset=+2]
3434
include::modules/serverless-ossm-enabling-serving-metrics.adoc[leveloffset=+2]
3535

0 commit comments

Comments
 (0)