Skip to content

Commit 116fc6c

Browse files
authored
Merge pull request #60736 from rh-tokeefe/OSSM-4039
OSSM-4039: Refine content for adding services to a mesh
2 parents 20d05a0 + 7ea9a96 commit 116fc6c

10 files changed

+63
-29
lines changed

modules/ossm-about-adding-namespace.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="ossm-about-adding-namespace_{context}"]
77
= About adding projects to a service mesh
88

9-
A project contains services; however, the services are only available if you add the project to the service mesh.
9+
After installing the Operators and creating the `ServiceMeshControlPlane` resource, add one or more projects to the service mesh.
1010

1111
[NOTE]
1212
====
@@ -21,4 +21,4 @@ You can add projects to an existing service mesh using either the {product-title
2121
2222
* Creating the `ServiceMeshMember` resource in the project.
2323
24-
If you choose to use the first method, then you must create the `ServiceMeshMemberRoll` resource.
24+
If you use the first method, then you must create the `ServiceMeshMemberRoll` resource.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
// * service_mesh/v2x/ossm-create-mesh.adoc
3+
4+
:_content-type: CONCEPT
5+
[id="ossm-about-adding-projects-using-smm_{context}"]
6+
= About adding projects using the ServiceMeshMember resource
7+
8+
A `ServiceMeshMember` resource provides a way to add a project to a service mesh without modifying the `ServiceMeshMemberRoll` resource. To add a project, create a `ServiceMeshMember` resource in the project that you want to add to the service mesh. When the {SMProductShortName} Operator processes the `ServiceMeshMember` object, the project appears in the `status.members` list of the `ServiceMeshMemberRoll` resource. Then, the services that reside in the project are made available to the mesh.
9+
10+
The mesh administrator must grant each mesh user permission to reference the `ServiceMeshControlPlane` resource in the `ServiceMeshMember` resource. With this permission in place, a mesh user can add a project to a mesh even when that user does not have direct access rights for the service mesh project or the `ServiceMeshMemberRoll` resource. For more information, see Creating the {SMProductName} members.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
// * service_mesh/v2x/ossm-create-mesh.adoc
3+
4+
:_content-type: CONCEPT
5+
[id="ossm-about-adding-projects-using-smmr_{context}"]
6+
= About adding projects using the ServiceMeshMemberRoll resource
7+
8+
Using the `ServiceMeshMemberRoll` resource is the simplest way to add a project to a service mesh. To add a project, specify the project name in the `spec.members` field of the `ServiceMeshMemberRoll` resource. The `ServiceMeshMemberRoll` resource specifies which projects are controlled by the `ServiceMeshControlPlane` resource.
9+
10+
[NOTE]
11+
====
12+
Adding projects using this method requires the user to have the `update servicemeshmemberrolls` and the `update pods` privileges in the project that is being added.
13+
====
14+
15+
* If you already have an application, workload, or service to add to the service mesh, see the following:
16+
** Adding or removing projects from the mesh using the `ServiceMeshMemberRoll` resource with the web console
17+
** Adding or removing projects from the mesh using the `ServiceMeshMemberRoll` resource with the CLI
18+
19+
* Alternatively, to install a sample application called Bookinfo and add it to a `ServiceMeshMemberRoll` resource, see the Bookinfo example application tutorial.

modules/ossm-add-project-member-roll-resource-cli.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="ossm-add-project-member-roll-resource-cli_{context}"]
7-
= Adding or removing projects from the service mesh using ServiceMeshMemberRoll resource with the CLI
7+
= Adding or removing projects from the mesh using ServiceMeshMemberRoll resource with the CLI
88

9-
You can add any number of projects, but a project can only belong to *one* `ServiceMeshMemberRoll` resource.
9+
You can add one or more projects to the mesh using the `ServiceMeshMemberRoll` resource with the CLI. You can add any number of projects, but a project can only belong to *one* mesh.
1010

1111
The `ServiceMeshMemberRoll` resource is deleted when its corresponding `ServiceMeshControlPlane` resource is deleted.
1212

modules/ossm-add-project-member-roll-resource-console.adoc

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

55
:_content-type: PROCEDURE
66
[id="ossm-add-project-member-roll-recourse-console_{context}"]
7-
= Adding or removing projects from the service mesh using ServiceMeshMemberRoll resource with the web console
7+
= Adding or removing projects from the mesh using the ServiceMeshMemberRoll resource with the web console
88

9-
You can add any number of projects, but a project can only belong to *one* `ServiceMeshMemberRoll` resource.
9+
You can add or remove projects from the mesh using the `ServiceMeshMemberRoll` resource with the {product-title} web console. You can add any number of projects, but a project can only belong to *one* mesh.
1010

1111
The `ServiceMeshMemberRoll` resource is deleted when its corresponding `ServiceMeshControlPlane` resource is deleted.
1212

1313
.Prerequisites
14+
1415
* An installed, verified {SMProductName} Operator.
1516
* An existing `ServiceMeshMemberRoll` resource.
1617
* The name of the project with the `ServiceMeshMemberRoll` resource.

modules/ossm-add-project-using-label-selectors-cli.adoc

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

55
:_content-type: PROCEDURE
66
[id="ossm-adding-project-using-label-selectors-cli_{context}"]
7-
= Adding a project to the {SMProductShortName} using label selectors with the CLI
7+
= Adding a project to the mesh using label selectors with the CLI
88

99
You can use label selectors to add a project to the {SMProductShortName} with the CLI.
1010

1111
.Prerequisites
12-
* The deployment has an installed, verified {SMProductName} Operator.
12+
* You have installed the {SMProductName} Operator.
1313
* The deployment has an existing `ServiceMeshMemberRoll` resource.
14-
* You are logged in as a user with mesh admin privileges.
14+
* You are logged in as a user with the `cluster-admin` role. If you use {product-dedicated}, you are logged in as a user with the `dedicated-admin` role.
1515
1616
.Procedure
1717

modules/ossm-add-project-using-label-selectors-console.adoc

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

55
:_content-type: PROCEDURE
66
[id="ossm-adding-project-using-label-selectors-console_{context}"]
7-
= Adding a project to the {SMProductShortName} using label selectors with the web console
7+
= Adding a project to the mesh using label selectors with the web console
88

99
You can use labels selectors to add a project to the {SMProductShortName} with the {product-title} web console.
1010

1111
.Prerequisites
12-
* The deployment has an installed, verified {SMProductName} Operator.
12+
* You have installed the {SMProductName} Operator.
1313
* The deployment has an existing `ServiceMeshMemberRoll` resource.
14-
* You are logged in as a user with mesh admin privileges.
14+
* You are logged in as a user with the `cluster-admin` role. If you use {product-dedicated}, you are logged in as a user with the `dedicated-admin` role.
1515
1616
.Procedure
1717

modules/ossm-adding-project-using-smm-resource-cli.adoc

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

55
:_content-type: PROCEDURE
66
[id="ossm-adding-project-using-smm-resource-cli_{context}"]
7-
= Adding a project to the service mesh using the ServiceMeshMember resource with the CLI
7+
= Adding a project to the mesh using the ServiceMeshMember resource with the CLI
88

9-
You can add one or more projects to the {SMProductShortName} from the CLI.
9+
You can add one or more projects to the mesh using the `ServiceMeshMember` resource with the CLI.
1010

1111
.Prerequisites
12-
* An installed, verified {SMProductName} Operator.
13-
* Name of the `ServiceMeshControlPlane` resource and the name of the project it belongs to.
14-
* Name of the project you want to add to the mesh.
15-
* A service mesh administrator must explicitly grant access to the service mesh. Administrators can grant users permissions to access the mesh by assigning them the `mesh-user` `Role` using a `RoleBinding` or `ClusterRoleBinding`. For more information, see xref:../../service_mesh/v2x/ossm-profiles-users.html#ossm-members_ossm-profiles-users[Creating the {SMProductName} members].
12+
* You have installed the {SMProductName} Operator.
13+
* You know the name of the `ServiceMeshControlPlane` resource and the name of the project it belongs to.
14+
* You know the name of the project you want to add to the mesh.
15+
* A service mesh administrator must explicitly grant access to the service mesh. Administrators can grant users permissions to access the mesh by assigning them the `mesh-user` `Role` using a `RoleBinding` or `ClusterRoleBinding`. For more information, see _Creating the {SMProductName} members_.
1616
1717
.Procedure
1818

modules/ossm-adding-project-using-smm-resource-console.adoc

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

55
:_content-type: PROCEDURE
66
[id="ossm-adding-project-using-smm-resource-console_{context}"]
7-
= Adding a project to the service mesh using the ServiceMeshMember resource with the web console
7+
= Adding a project to the mesh using the ServiceMeshMember resource with the web console
88

9-
You can add one or more projects to the {SMProductShortName} from the {product-title} web console.
9+
You can add one or more projects to the mesh using the `ServiceMeshMember` resource with the {product-title} web console.
1010

1111
.Prerequisites
12-
* An installed, verified {SMProductName} Operator.
13-
* Name of the `ServiceMeshControlPlane` resource and the name of the project that the resource belongs to.
14-
* Name of the project you want to add to the mesh.
15-
* A service mesh administrator must explicitly grant access to the service mesh. Administrators can grant users permissions to access the mesh by assigning them the `mesh-user` `Role` using a `RoleBinding` or `ClusterRoleBinding`. For more information, see xref:../../service_mesh/v2x/ossm-profiles-users.html#ossm-members_ossm-profiles-users[Creating the {SMProductName} members].
12+
* You have installed the {SMProductName} Operator.
13+
* You know the name of the `ServiceMeshControlPlane` resource and the name of the project that the resource belongs to.
14+
* You know the name of the project you want to add to the mesh.
15+
* A service mesh administrator must explicitly grant access to the service mesh. Administrators can grant users permissions to access the mesh by assigning them the `mesh-user` `Role` using a `RoleBinding` or `ClusterRoleBinding`. For more information, see _Creating the {SMProductName} members_.
1616
1717
.Procedure
1818

service_mesh/v2x/ossm-create-mesh.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,23 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
After installing the Operators and creating the `ServiceMeshControlPlane` resource, add one or more projects to the service mesh.
9+
A project contains services; however, the services are only available if you add the project to the service mesh.
1010

1111
include::modules/ossm-about-adding-namespace.adoc[leveloffset=+1]
1212

1313
include::modules/ossm-member-roll-create.adoc[leveloffset=+1]
1414

15-
include::modules/ossm-add-project-member-roll-resource-console.adoc[leveloffset=+1]
15+
include::modules/ossm-about-adding-projects-using-smmr.adoc[leveloffset=+1]
1616

17-
include::modules/ossm-add-project-member-roll-resource-cli.adoc[leveloffset=+1]
17+
include::modules/ossm-add-project-member-roll-resource-console.adoc[leveloffset=+2]
1818

19-
include::modules/ossm-adding-project-using-smm-resource-console.adoc[leveloffset=+1]
19+
include::modules/ossm-add-project-member-roll-resource-cli.adoc[leveloffset=+2]
2020

21-
include::modules/ossm-adding-project-using-smm-resource-cli.adoc[leveloffset=+1]
21+
include::modules/ossm-about-adding-projects-using-smm.adoc[leveloffset=+1]
22+
23+
include::modules/ossm-adding-project-using-smm-resource-console.adoc[leveloffset=+2]
24+
25+
include::modules/ossm-adding-project-using-smm-resource-cli.adoc[leveloffset=+2]
2226

2327
include::modules/ossm-about-adding-projects-using-label-selectors.adoc[leveloffset=+1]
2428

0 commit comments

Comments
 (0)