Skip to content

Commit d2504ef

Browse files
authored
Merge pull request #90362 from openshift-cherrypick-robot/cherry-pick-89492-to-service-mesh-docs-3.0
2 parents 6c060cc + 5719208 commit d2504ef

File tree

36 files changed

+101
-119
lines changed

36 files changed

+101
-119
lines changed

_topic_maps/_topic_map.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,43 +13,43 @@ Dir: migrating
1313
Distros: openshift-service-mesh
1414
Topics:
1515
- Name: Migrating from Service Mesh 2 to Service Mesh 3
16-
File: ossm-migrating-from-service-mesh-2-to-3-assembly
16+
File: ossm-migrating-from-service-mesh-2-to-3
1717
- Name: Before migrating
1818
Dir: checklists
1919
Topics:
2020
- Name: Important information to know before migrating
21-
File: ossm-migrating-read-me-assembly
21+
File: ossm-migrating-read-me
2222
- Name: Premigration checklists
23-
File: ossm-migrating-premigration-checklists-assembly
23+
File: ossm-migrating-premigration-checklists
2424
- Name: Migrating network policies
25-
File: ossm-migrating-network-policies-assembly
25+
File: ossm-migrating-network-policies
2626
- Name: Kiali differences for Service Mesh 3
27-
File: ossm-migrating-kiali-differences-assembly
27+
File: ossm-migrating-kiali-differences
2828
- Name: Multitenant migration guide
2929
Dir: multitenant
3030
Topics:
31-
- Name: Migrating a multitenant deployment
32-
File: ossm-migrating-multitenant-assembly
31+
- Name: Multitenant migration guide
32+
File: ossm-migrating-multitenant
3333
- Name: Cluster-wide migration guide
3434
Dir: cluster-wide
3535
Topics:
36-
- Name: Migrating a cluster-wide deployment
37-
File: ossm-migrating-cluster-wide-assembly
36+
- Name: Cluster-wide migration guide
37+
File: ossm-migrating-cluster-wide
3838
- Name: Migrating gateways
3939
Dir: migrating-gateways
4040
Topics:
41-
- Name: Migrating gateways from Service Mesh 2 to Service Mesh 3
42-
File: ossm-migrating-gateways-assembly
41+
- Name: Migrating gateways
42+
File: ossm-migrating-gateways
4343
- Name: Completing the migration
4444
Dir: done
4545
Topics:
4646
- Name: Completing the Migration
47-
File: ossm-migrating-complete-assembly
47+
File: ossm-migrating-complete
4848
- Name: Reference
4949
Dir: reference
5050
Topics:
5151
- Name: Migrating references
52-
File: ossm-migrating-references-assembly
52+
File: ossm-migrating-references
5353
---
5454
Name: About
5555
Dir: about

about/ossm-about-concepts-assembly.adoc

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
:_content-type: ASSEMBLY
2-
[id=ossm-understanding-service-mesh-assembly_{context}]
2+
[id="ossm-understanding-service-mesh-assembly"]
33
= Understanding OpenShift Service Mesh
44
include::_attributes/common-attributes.adoc[]
55
:context: ossm-about-concepts-assembly
66

7-
//Conceptual information that is needed for users moving from 2.x to 3, and for new users to understand and orient themselves OSSM 3.x.
8-
//Customers who are using 3.O TP1 have expressed a need for this content.
9-
//Did not like calling it "Service Mesh Concepts", though not sold on "Understanding Service Mesh" but like it better than "Service Mesh concepts".
10-
//TP1 content so likely all info architecture, content, etc will change by GA
11-
//Kiali attributes are influx
12-
137
toc::[]
148

159
{SMProductName} is composed of two parts:
@@ -31,7 +25,7 @@ Kali provided by Red Hat is composed of three parts:
3125
** {OTELOperator}
3226
* cert-manager
3327
* Argo rollouts
34-
// * Integration of {SMProduct} with 3rd party components that support community Istio integrations --> commented out as none are currently documented in prod docs that are not supported by Red Hat, but support may change for GA so leaving as place holder.
28+
// * Integration of {SMProduct} with 3rd party components that support community Istio integrations --> commented out as none are currently documented in prod docs that are not supported by Red Hat, but support may change.
3529
3630
include::modules/ossm-about-concepts-resources.adoc[leveloffset=+1]
3731

install/ossm-deploying-multiple-service-meshes-on-single-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="ossm-deploying-multiple-service-meshes-on-single-cluster_{context}"]
2+
[id="ossm-deploying-multiple-service-meshes-on-single-cluster"]
33
= Deploying multiple service meshes on a single cluster
44
include::_attributes/common-attributes.adoc[]
55
:context: ossm-deploying-multiple-service-meshes-on-single-cluster

install/ossm-enabling-mtls.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_content-type: ASSEMBLY
2-
[id="ossm-enabling-mtls_{context}"]
2+
[id="ossm-enabling-mtls"]
33
= Enabling mutual Transport Layer Security
44
include::_attributes/common-attributes.adoc[]
55
:context: ossm-enabling-mtls

install/ossm-installing-openshift-service-mesh.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Installing {ocp-short-name} {SMProductShortName} consists of three main tasks: i
1010

1111
[WARNING]
1212
====
13-
Before migrating from {SMProduct} 2, make sure you are not running {SMProduct} 3 and {SMProduct} 2 in the same cluster, because it causes conflicts unless configured correctly. To migrate from {SMProduct} 2, see xref:../migrating/checklists/ossm-migrating-read-me-assembly.adoc#ossm-migrating-read-me-assembly[Migrating from {SMProduct} 2.6].
13+
Before migrating from {SMProduct} 2, make sure you are not running {SMProduct} 3 and {SMProduct} 2 in the same cluster, because it causes conflicts unless configured correctly. To migrate from {SMProduct} 2, see xref:../migrating/checklists/ossm-migrating-read-me.adoc#ossm-migrating-read-me[Migrating from {SMProduct} 2.6].
1414
====
1515

1616
include::modules/ossm-about-deploying-istio-using-service-mesh-operator.adoc[leveloffset=+1]

install/ossm-running-v2-same-cluster-as-v3-assembly.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_content-type: ASSEMBLY
2-
[id="ossm-running-v2-same-cluster-as-v3_{context}"]
2+
[id="ossm-running-v2-same-cluster-as-v3"]
33
= Running {SMProduct} 2.6 in the same cluster as {SMProduct} 3
44
include::_attributes/common-attributes.adoc[]
55
:context: ossm-running-v2-same-cluster-as-v3-assembly

migrating/checklists/ossm-migrating-kiali-differences-assembly.adoc renamed to migrating/checklists/ossm-migrating-kiali-differences.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
// * migrating/checklists/ossm-kiali-differences-assembly.adoc
44

55
:_mod-docs-content-type: ASSEMBLY
6-
[id="ossm-migrating-kiali-differences-assembly"]
6+
[id="ossm-migrating-kiali-differences"]
77
= Kiali differences for {SMProductName} 3
88
include::_attributes/common-attributes.adoc[]
9-
:context: ossm-migrating-kiali-differences-assembly
9+
:context: ossm-migrating-kiali-differences
1010

1111
toc::[]
1212

migrating/checklists/ossm-migrating-network-policies-assembly.adoc renamed to migrating/checklists/ossm-migrating-network-policies.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="ossm-migrating-network-policies-assembly"]
2+
[id="ossm-migrating-network-policies"]
33
= Migrating network policies from Service Mesh 2 to Service Mesh 3
44
include::_attributes/common-attributes.adoc[]
5-
:context: ossm-migrating-network-policies-assembly
5+
:context: ossm-migrating-network-policies
66

77
toc::[]
88

migrating/checklists/ossm-migrating-premigration-checklists-assembly.adoc renamed to migrating/checklists/ossm-migrating-premigration-checklists.adoc

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="ossm-migrating-premigration-checklists-assembly"]
2+
[id="ossm-migrating-premigration-checklists"]
33
= Premigration checklists
44
include::_attributes/common-attributes.adoc[]
5-
:context: ossm-migrating-premigration-checklists-assembly
5+
:context: ossm-migrating-premigration-checklists
66

77
toc::[]
88

9-
//Kathryn suggested I try to follow this: https://github.com/openshift/openshift-docs/blob/enterprise-4.18/migrating_from_ocp_3_to_4/premigration-checklists-3-4.adoc?plain=1
10-
11-
129
.Before you begin
1310

1411
* You have read "Migrating from Service Mesh 2 to Service Mesh 3".
15-
* You have read and understand the xref:../../migrating/checklists/ossm-migrating-read-me-assembly.adoc#ossm-2-and-3-differences_ossm-migrating-read-me-assembly[differences between OpenShift Service Mesh 2 and OpenShift Service Mesh 3].
16-
* You have reviewed the xref:../../migrating/reference/ossm-migrating-references-assembly.adoc[Migrating references] material.
12+
* You have read and understand the xref:../../migrating/checklists/ossm-migrating-read-me.adoc#ossm-2-and-3-differences_ossm-migrating-read-me[differences between OpenShift Service Mesh 2 and OpenShift Service Mesh 3].
13+
* You have reviewed the xref:../../migrating/reference/ossm-migrating-references.adoc[Migrating references] material.
1714
* You want to migrate from {SMProduct} 2 to {SMProduct} 3.
1815
* You are running {SMProduct} {SMv2Version}.
1916
* You have upgraded your `ServiceMeshControlPlane` resource to the latest version.
@@ -66,7 +63,7 @@ If you do not want your network policies in place during your migration:
6663

6764
If you want your network policies in place during your migration:
6865

69-
* [ ] Manually xref:../../migrating/checklists/ossm-migrating-network-policies-assembly.adoc#ossm-migrating-network-policies-setup-during-migration_ossm-migrating-network-policies-assembly[set up network policies to use during migration].
66+
* [ ] Manually xref:../../migrating/checklists/ossm-migrating-network-policies.adoc#ossm-migrating-network-policies-setup-during-migration_ossm-migrating-network-policies[set up network policies to use during migration].
7067
* [ ] Disable network policy management in the {SMProduct} 2 `ServiceMeshControlPlane` resource: `spec.security.manageNetworkPolicy=false`.
7168
* [ ] Complete the rest of the checklists.
7269
* [ ] Migrate your deployment and workloads.
@@ -95,13 +92,13 @@ oc get smcp <smcp-name> -n <smcp-namespace> -o jsonpath='{.spec.mode}'
9592
If you did not set a value for the `.spec.mode` parameter in your `ServiceMeshControlPlane` resource, your deployment is multitenant.
9693
====
9794

98-
[id="migrate-based-on-your-deployment-model"]
95+
[id="migrate-based-on-your-deployment-model_{context}"]
9996
== Migrate based on your deployment model
10097

10198
If you are not using the cert-manager tool with your deployment, you are ready to migrate your deployment.
10299

103-
* xref:../../migrating/multitenant/ossm-migrating-multitenant-assembly.adoc[Multitenant migration guide]
104-
* xref:../../migrating/cluster-wide/ossm-migrating-cluster-wide-assembly.adoc[Cluster-wide migration guide]
100+
* xref:../../migrating/multitenant/ossm-migrating-multitenant.adoc[Multitenant migration guide]
101+
* xref:../../migrating/cluster-wide/ossm-migrating-cluster-wide.adoc[Cluster-wide migration guide]
105102

106103
If you are unsure, you can check if you are using the cert-manager tool with your deployment.
107104

@@ -111,8 +108,8 @@ include::modules/ossm-migrating-premigration-checklists-using-the-cert-manager-t
111108

112109
There are some configurations you must complete first before you can start migrating your deployments.
113110

114-
* xref:../../migrating/multitenant/ossm-migrating-multitenant-assembly.adoc#migrating-multitenant-with-cert-manager_ossm-migrating-multitenant-assembly[Migrating a multitenant deployment with the cert-manager tool]
115-
* xref:../../migrating/cluster-wide/ossm-migrating-cluster-wide-assembly.adoc#ossm-cluster-wide-migration-methods_ossm-migrating-cluster-wide-assembly[Cluster-wide migration methods]
111+
* xref:../../migrating/multitenant/ossm-migrating-multitenant.adoc#migrating-multitenant-with-cert-manager_ossm-migrating-multitenant[Migrating a multitenant deployment with the cert-manager tool]
112+
* xref:../../migrating/cluster-wide/ossm-migrating-cluster-wide.adoc#ossm-cluster-wide-migration-methods_ossm-migrating-cluster-wide[Cluster-wide migration methods]
116113

117114
//Per engineering, uncomment Final check after GA
118115
//move to module when uncommenting

migrating/checklists/ossm-migrating-read-me-assembly.adoc renamed to migrating/checklists/ossm-migrating-read-me.adoc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="ossm-migrating-read-me-assembly"]
2+
[id="ossm-migrating-read-me"]
33
= Important information to know if you are migrating from OpenShift Service Mesh 2.6
44
include::_attributes/common-attributes.adoc[]
5-
:context: ossm-migrating-read-me-assembly
5+
:context: ossm-migrating-read-me
66

77
toc::[]
88

99
If you are moving from {SMProductName} 2.6 to {SMProductName} 3, read the content in this section first as it contains important information and explanations on the differences between the versions. These differences have a direct impact on your installation and configuration of {SMProduct} 3.
1010

11-
//Note to reviewers: this is existing content: https://docs.redhat.com/en/documentation/red_hat_openshift_service_mesh/3.0.0tp1/html/migrating_from_openshift_service_mesh_2.6/important-information-to-know-before-migrating
12-
//There were exref updates as this content is moving into a different dir under dir: Migrating
13-
1411
include::modules/ossm-migrating-2-and-3-differences.adoc[leveloffset=+1]
1512
include::modules/ossm-migrating-read-me-new-operator.adoc[leveloffset=+1]
1613
include::modules/ossm-migrating-read-me-new-resources.adoc[leveloffset=+1]
@@ -51,7 +48,7 @@ include::modules/ossm-migrating-read-me-kubernetes-network-policy-management.ado
5148
include::modules/ossm-migrating-read-me-tls-configuration-change.adoc[leveloffset=+1]
5249

5350
[role="_additional-resources"]
54-
[id="addition-resource_{context}"]
51+
[id="additional-resource_{context}"]
5552
== Additional Resources
5653

5754
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/#Observability[Red Hat OpenShift Observability]
@@ -61,5 +58,3 @@ include::modules/ossm-migrating-read-me-tls-configuration-change.adoc[leveloffse
6158
* link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Labels and Selectors] (Kubernetes documentation)
6259
* link:https://istio.io/latest/docs/tasks/security/tls-configuration/workload-min-tls-version/[Istio Workload Minimum TLS Version Configuration] (Istio documentation)
6360
* link:https://istio.io/latest/docs/reference/config/security/authorization-policy/[Authorization Policies] (Istio documentation)
64-
65-
//Migration likely to resemble https://docs.openshift.com/container-platform/4.17/migrating_from_ocp_3_to_4/about-migrating-from-3-to-4.html#about-migrating-from-3-to-4 when done for OSSM 3.0 GA.

0 commit comments

Comments
 (0)