W-13513395 cm traffic management gr #524

glenn-rodgers-sf · 2023-06-26T14:34:38Z

Writer's Quality Checklist

Before merging your PR, did you:

Run spell checker
Run link checker to check for broken xrefs
Check for orphan files
Perform a local build and do a final visual check of your content, including checking for:
- Broken images
- Dead links
- Correct rendering of partials if they are used in your content
- Formatting issues, such as:
  - Misnumbered ordered lists (steps) or incorrectly nested unordered lists
  - Messed up tables
  - Proper indentation
  - Correct header levels
Receive final review and signoff from:
- Technical SME
- Product Manager
- Editor or peer reviewer
- Reporter, if this content is in response to a reported issue (internal or external feedback)
If applicable, verify that the software actually got released

modules/ROOT/pages/create-instance-task-flex.adoc

dhirsch1 · 2023-06-29T21:09:40Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+. Click *Add header (optional)*, if this is not your first header.
+. Enter the header name in the first box.
+. Enter `true` or `false` dependent on if the header must be present.


Suggested change

. Enter `true` or `false` dependent on if the header must be present.

. Enter `true` or `false`, depending on whether the header must be present.

Suggestion: ...the header present in the request

modules/ROOT/pages/create-instance-task-flex.adoc

dhirsch1 · 2023-06-29T21:15:27Z

modules/ROOT/pages/_partials/task-add-api-instance.adoc

@@ -33,4 +33,8 @@ instance.

 When you are promoting or importing an API instance, you do not have options to alter the configuration. However, when you add a new API instance, you need to the downstream and the upstream configuration settings.

+The following diagram demonstrates the upstream and downstream configurations settings relationship to your upstream service and consumer application.


Suggestion: ...shows the relationship of the upstream and downstream configuration settings to your upstream service and consumer application.

The way you have it written, you would need to change "configurations settings relationship" to "configuration settings' relationship." This wording is awkward.

dhirsch1 · 2023-06-29T21:21:18Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+Flex Gateway version 1.5.x or later supports API instances that expose multiple upstream services through a single consumer endpoint.
+
+Flex Gateway manages traffic by using different routes with defined rulesets and route order to direct traffic to different sets of upstream services. Each API instance supports multiple routes that can each direct traffic to multiple upstream services.


Suggestion to shorten the wording: Flex Gateway uses different routes... (since you mention that it directs traffic, I don't think you need "manages traffic" as well).

Where is route order defined? This wording implies that it is defined on each route, but that is probably incorrect. If you flip the wording, it would be clearer:

Flex Gateway uses the configured route order and routes with defined rulesets...

Suggestion to split the last sentence in two. "multiple routes" does not really go with "each."

dhirsch1 · 2023-06-29T21:30:40Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+=== Routes
+
+Each API instance supports up to 10 routes and each route can support up to 10 upstream services. You configure what routes receive what requests by defining route rules and route order. Only one route per API instance is required. 


Suggested change

Each API instance supports up to 10 routes and each route can support up to 10 upstream services. You configure what routes receive what requests by defining route rules and route order. Only one route per API instance is required.

Each API instance supports up to 10 routes and each route can support up to 10 upstream services. Configure what requests a route can receive by defining route rules and a route order. Only one route per API instance is required.

Maybe: At least one route per API instance is required.

modules/ROOT/pages/create-instance-task-flex.adoc

dhirsch1 · 2023-06-30T14:08:33Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+The *Headers* rule defines what headers are required to be present or not present for this route to service the request.
+
+For this rule, you must define the header name and a `true` or `false` value of whether or not the header is present. Only requests that meet all the specified header requirements are sent to this route. Additional headers present in the request that are not specifically defined in the rules are ignored. 


Are they writing true and false or selecting this value?

modules/ROOT/pages/create-instance-task-flex.adoc

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

modules/ROOT/pages/create-instance-task-flex.adoc

dhirsch1 · 2023-06-30T16:26:29Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+Defines the types of request methods that the route can service.
+
+You can select multiple methods for each route. Only requests that are one of the defined methods are directed to this route.


Are requests a method?

Yes, you could have GET requests or POST requests and so on.

Ah - REST requests

modules/ROOT/pages/create-instance-task-flex.adoc

dhirsch1 · 2023-06-30T16:41:56Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+To view and edit route rules, click *Route Rules*.
+
+All rules are optional. Not defining a value for a rule means that aspect of the request is not considered. For example, not specifying a host means that the route can service any host if the request meets the other route rules. Not defining any rule means that the route can service every request.


This sentence is problematic. (See my earlier review comment on this.)

modules/ROOT/pages/create-instance-task-flex.adoc

dhirsch1 · 2023-06-30T16:45:15Z

modules/ROOT/pages/create-instance-task-flex.adoc

+
+Route ordering is very important when a request can meet the route rules of multiple routes. You should order the routes with more complex route rules first. If you do not define a route order, routes are ordered in the order they were created.
+
+For example, in a configuration where route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two.


Suggested change

For example, in a configuration where route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two.

For example, in a configuration in which route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two.

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

…t-gr

glenn-rodgers-sf added 5 commits June 24, 2023 13:22

Update create-instance-task-flex.adoc

776f793

Images

b818330

Add traffic management section

cc5a319

Edits

be37e2f

Edits

9466de5

glenn-rodgers-sf requested review from priyaayyar and a team as code owners June 26, 2023 14:34

glenn-rodgers-sf added 12 commits June 26, 2023 09:43

Instructions

4a8b4c3

reorder

82175dd

edit

116406e

Rules table

0da493e

Edits

0c69059

Edits

2b7d3ec

Edit

c87f2bc

Edits

e44d0ee

edits

6803bf1

Edits

1b9a54b

Edits

71b7435

Edits

0fb429c

glenn-rodgers-sf changed the title ~~W 13513395 cm traffic management gr~~ W-13513395 cm traffic management gr Jun 26, 2023

glenn-rodgers-sf added 4 commits June 27, 2023 11:59

Typo

84b62f4

typo

3e13df6

Policy availibility

59521c1

Services

65fbfc1

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 29, 2023

View reviewed changes

dhirsch1 approved these changes Jun 30, 2023

View reviewed changes

glenn-rodgers-sf and others added 5 commits June 30, 2023 10:21

Update modules/ROOT/pages/create-instance-task-flex.adoc

81de337

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Apply suggestions from code review

2efa4fc

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Diane edits

8bbd51f

Route order

485b17d

Edits

c4ef69b

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

dhirsch1 approved these changes Jun 30, 2023

View reviewed changes

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

modules/ROOT/pages/create-instance-task-flex.adoc Outdated Show resolved Hide resolved

dhirsch1 reviewed Jun 30, 2023

View reviewed changes

glenn-rodgers-sf and others added 9 commits June 30, 2023 13:46

Apply suggestions from code review

6d37726

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Update modules/ROOT/pages/create-instance-task-flex.adoc

24a21d0

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Update modules/ROOT/pages/create-instance-task-flex.adoc

be49cf1

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Update modules/ROOT/pages/create-instance-task-flex.adoc

f0f33fd

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Update modules/ROOT/pages/create-instance-task-flex.adoc

f9d838f

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Update modules/ROOT/pages/create-instance-task-flex.adoc

afef588

Co-authored-by: Diane E Hirsch <diane.hirsch@mulesoft.com>

Diane edit

fed4001

Edits

46bb924

Merge branch 'flex-gateway-v1-5' into W-13513395-CM-traffic-managemen…

181ec19

…t-gr

dhirsch1 approved these changes Jun 30, 2023

View reviewed changes

glenn-rodgers-sf merged commit d46bf45 into flex-gateway-v1-5 Jun 30, 2023

glenn-rodgers-sf deleted the W-13513395-CM-traffic-management-gr branch June 30, 2023 19:31

	. Enter `true` or `false` dependent on if the header must be present.
	. Enter `true` or `false`, depending on whether the header must be present.

		@@ -33,4 +33,8 @@ instance.

		When you are promoting or importing an API instance, you do not have options to alter the configuration. However, when you add a new API instance, you need to the downstream and the upstream configuration settings.

		The following diagram demonstrates the upstream and downstream configurations settings relationship to your upstream service and consumer application.


		Flex Gateway version 1.5.x or later supports API instances that expose multiple upstream services through a single consumer endpoint.

		Flex Gateway manages traffic by using different routes with defined rulesets and route order to direct traffic to different sets of upstream services. Each API instance supports multiple routes that can each direct traffic to multiple upstream services.


		=== Routes

		Each API instance supports up to 10 routes and each route can support up to 10 upstream services. You configure what routes receive what requests by defining route rules and route order. Only one route per API instance is required.


		To view and edit route rules, click Route Rules.

		All rules are optional. Not defining a value for a rule means that aspect of the request is not considered. For example, not specifying a host means that the route can service any host if the request meets the other route rules. Not defining any rule means that the route can service every request.


		Route ordering is very important when a request can meet the route rules of multiple routes. You should order the routes with more complex route rules first. If you do not define a route order, routes are ordered in the order they were created.

		For example, in a configuration where route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two.

	For example, in a configuration where route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two.
	For example, in a configuration in which route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two.

W-13513395 cm traffic management gr #524

W-13513395 cm traffic management gr #524

Uh oh!

Conversation

glenn-rodgers-sf commented Jun 26, 2023

Writer's Quality Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dhirsch1 Jun 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dhirsch1 Jun 29, 2023 •

edited

Loading