Skip to content

Commit 2dcaa07

Browse files
michaelklishinmichaelklishin
authored
Merge pull request #2210 from rabbitmq/edits-for-#2209
[TNZDOC-718] Edits
2 parents d71a1bd + 139d1f4 commit 2dcaa07

File tree

6 files changed

+150
-133
lines changed

6 files changed

+150
-133
lines changed

‎docs/oauth2-examples-idp-initiated.md

+42-36
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,14 @@ limitations under the License.
2121

2222
# Use Identity Provider Initiated Logon
2323

24-
This guide explains how to set up Identity Provider Initiated Logon
25-
using UAA as Authorization Server and a sample Node.js web application as a Web Portal.
24+
This topic tells you how to set up Identity Provider Initiated Logon using UAA as the authorization
25+
server and a sample Node.js web application as a web portal.
2626

27-
The web portal acts as an identity provider, allowing users to access the
28-
management UI with a single click using an OAuth 2.0 token previously
29-
obtained from the authorization server.
27+
The web portal acts as an identity provider, allowing users to access the management UI with a
28+
single click by using an OAuth 2.0 token previously obtained from the authorization server.
3029

3130
```
32-
| Idp (e.g.UAA) |
31+
| Idp (for example, UAA) |
3332
/\
3433
| 2. get token
3534
|
@@ -38,77 +37,84 @@ obtained from the authorization server.
3837
| | | | with cookie
3938
| | +-----------+
4039
| |
41-
1. user requests 3. POST https://rabbitmq:15671/login
42-
access with access_token
43-
to management ui
40+
1. user requests 3. POST https://rabbitmq:15671/login
41+
access with access_token
42+
to the management UI
4443
4544
```
4645

47-
* Access [management UI](./management/) via a browser
46+
Access the [management UI](./management/) from a browser.
4847

4948
## Prerequisites to follow this guide
5049

5150
* Docker
52-
* A local clone of a [GitHub repository](https://github.com/rabbitmq/rabbitmq-oauth2-tutorial/tree/next) for branch `next` that contains all the configuration files and scripts used on this example.
53-
54-
:::info
55-
The commands used to start UAA, RabbitMQ and the web portal automatically
56-
generate their x.509 certificates required for https.
51+
* A local clone of a
52+
[GitHub repository](https://github.com/rabbitmq/rabbitmq-oauth2-tutorial/tree/next) for branch
53+
`next` that contains all the configuration files and scripts used on this example
5754

55+
:::info
56+
The commands used to start UAA, RabbitMQ, and the web portal automatically generate their x.509
57+
certificates required for HTTPS.
5858
:::
5959

60-
## Deploy UAA
60+
## Deploy UAA
6161

62-
Run the following commands to start UAA:
62+
To start UAA run:
6363

6464
```bash
6565
make start-uaa
6666
```
67-
68-
To check if UAA is running, run `docker ps | grep uaa`
6967

70-
## Deploy RabbitMQ
68+
To check if UAA is running, run:
69+
70+
```bash
71+
docker ps | grep uaa
72+
```
7173

72-
Run the following commands to start RabbitMQ:
74+
## Deploy RabbitMQ
75+
76+
To start RabbitMQ, run:
7377

7478
```bash
7579
export MODE=portal
7680
OAUTH_PROVIDER=uaa make start-rabbitmq
7781
```
7882

7983
:::tip
80-
Ensure RabbitMQ is deployed with the version you expect by searching for
81-
`Running RabbitMQ (<image>:<image_tag>) with` in `docker logs rabbitmq`.
84+
Ensure that RabbitMQ is deployed with the version you expect by searching for
85+
`Running RabbitMQ (<image>:<image_tag>) with` in `docker logs rabbitmq`.
8286
:::
8387

8488
:::info
85-
To start one specific version of RabbitMQ run the following command instead:
86-
```bash
89+
To start one specific version of RabbitMQ, run this command instead:
90+
```bash
8791
MODE=portal OAUTH_PROVIDER=uaa IMAGE=rabbitmq IMAGE_TAG=<YourVersion> make start-rabbitmq
8892
```
8993
:::
9094

91-
## Deploy Portal
95+
## Deploy Portal
9296

93-
Run the following commands to start Portal:
97+
To start Portal, run:
9498

9599
```bash
96100
make start-portal
97101
```
98102

99-
## Verify Management UI flows
103+
## Verify management UI flows
104+
105+
To verify management UI flows:
100106

101107
1. Go to the portal `https://localhost:3000`.
102-
2. Click on the button `https://localhost:15671 for rabbit_idp_user`.
103-
3. It redirects to RabbitMQ management UI fully authenticated.
108+
2. Click the button **https://localhost:15671 for rabbit_idp_user**, which redirects you to the
109+
RabbitMQ management UI fully authenticated.
104110

105-
:::info
106-
`rabbit_idp_user` is the OAuth Client the portal uses to obtain an access token to
107-
test this flow. This OAuth Client is declared in UAA.
111+
:::info
112+
`rabbit_idp_user` is the OAuth Client the portal uses to obtain an access token to test this flow.
113+
This OAuth Client is declared in UAA.
108114
:::
109115

110116
:::warning
111-
When you visit https://localhost:3000 you will get a browser warning
112-
due to net::ERR_CERT_AUTHORITY_INVALID. This is because the portal
113-
is using a self-signed certificate. You accept it by clicking on `Proceed to localhost (unsafe)`.
117+
When you visit `https://localhost:3000` you get a browser warning because of the error
118+
`net::ERR_CERT_AUTHORITY_INVALID`. This is because the portal is using a self-signed certificate.
119+
Click on `Proceed to localhost (unsafe)` to accept it.
114120
:::

‎docs/oauth2-examples/index.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -160,12 +160,11 @@ auth_oauth2.issuer = https://uaa:8443
160160
# ...
161161
```
162162

163-
:::tip
163+
:::tip
164164
You only need to set `management.oauth_provider_url` when you have not configured
165-
`auth_oauth2.issuer` and/or they have different urls.
165+
`auth_oauth2.issuer` and/or they have different URLs.
166166
:::
167167

168-
169168
### Identity-Provider initiated logon {#identity-provider-initiated-logon}
170169

171170
Like Service-Provider initiated logon, with Idp-initiated logon users get to the RabbitMQ Management UI with a valid token.
@@ -187,12 +186,12 @@ by submitting a form with their OAuth token in the `access_token` form field as
187186
/|\ |
188187
| |
189188
1. rabbit_admin from a browser <-----3. 302 redirect to RabbitMQ w/cookie--+
190-
189+
191190
```
192191

193-
If the access token is valid, RabbitMQ redirects the user to the **Overview** page with
194-
a cookie which carries the validated token. When RabbitMQ delivers the **Overview** page,
195-
it clears the cookie.
192+
If the access token is valid, RabbitMQ redirects the user to the **Overview** page with a cookie
193+
that carries the validated token. When RabbitMQ delivers the **Overview** page, it clears the
194+
cookie.
196195

197196
By default, the RabbitMQ Management UI is configured with **service-provider initiated logon**, to configure **Identity-Provider initiated logon**, the following configuration entries are required in `rabbitmq.conf`:
198197

@@ -204,9 +203,9 @@ management.oauth_provider_url = http://localhost:8080
204203
# ...
205204
```
206205

207-
:::tip
206+
:::tip
208207
You only need to set `management.oauth_provider_url` when you have not configured
209-
`auth_oauth2.issuer` and/or they have different urls.
208+
`auth_oauth2.issuer` and/or they have different URLs.
210209
:::
211210

212211
**Important**: when the user logs out, or its RabbitMQ session expires, or the token expires, the user is directed to the

‎versioned_docs/version-3.13/oauth2-examples-idp-initiated.md

+42-36
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,14 @@ limitations under the License.
2121

2222
# Use Identity Provider Initiated Logon
2323

24-
This guide explains how to set up Identity Provider Initiated Logon
25-
using UAA as Authorization Server and a sample Node.js web application as a Web Portal.
24+
This topic tells you how to set up Identity Provider Initiated Logon using UAA as the authorization
25+
server and a sample Node.js web application as a web portal.
2626

27-
The web portal acts as an identity provider, allowing users to access the
28-
management UI with a single click using an OAuth 2.0 token previously
29-
obtained from the authorization server.
27+
The web portal acts as an identity provider, allowing users to access the management UI with a
28+
single click by using an OAuth 2.0 token previously obtained from the authorization server.
3029

3130
```
32-
| Idp (e.g.UAA) |
31+
| Idp (for example, UAA) |
3332
/\
3433
| 2. get token
3534
|
@@ -38,77 +37,84 @@ obtained from the authorization server.
3837
| | | | with cookie
3938
| | +-----------+
4039
| |
41-
1. user requests 3. POST https://rabbitmq:15671/login
42-
access with access_token
43-
to management ui
40+
1. user requests 3. POST https://rabbitmq:15671/login
41+
access with access_token
42+
to the management UI
4443
4544
```
4645

47-
* Access [management UI](./management/) via a browser
46+
Access the [management UI](./management/) from a browser.
4847

4948
## Prerequisites to follow this guide
5049

5150
* Docker
52-
* A local clone of a [GitHub repository](https://github.com/rabbitmq/rabbitmq-oauth2-tutorial) that contains all the configuration files and scripts used on this example.
53-
54-
:::info
55-
The commands used to start UAA, RabbitMQ and the web portal automatically
56-
generate their x.509 certificates required for https.
51+
* A local clone of a
52+
[GitHub repository](https://github.com/rabbitmq/rabbitmq-oauth2-tutorial/tree/next) for branch
53+
`next` that contains all the configuration files and scripts used on this example
5754

55+
:::info
56+
The commands used to start UAA, RabbitMQ, and the web portal automatically generate their x.509
57+
certificates required for HTTPS.
5858
:::
5959

60-
## Deploy UAA
60+
## Deploy UAA
6161

62-
Run the following commands to start UAA:
62+
To start UAA run:
6363

6464
```bash
6565
make start-uaa
6666
```
67-
68-
To check if UAA is running, run `docker ps | grep uaa`
6967

70-
## Deploy RabbitMQ
68+
To check if UAA is running, run:
69+
70+
```bash
71+
docker ps | grep uaa
72+
```
7173

72-
Run the following commands to start RabbitMQ:
74+
## Deploy RabbitMQ
75+
76+
To start RabbitMQ, run:
7377

7478
```bash
7579
export MODE=portal
7680
OAUTH_PROVIDER=uaa make start-rabbitmq
7781
```
7882

7983
:::tip
80-
Ensure RabbitMQ is deployed with the version you expect by searching for
81-
`Running RabbitMQ (<image>:<image_tag>) with` in `docker logs rabbitmq`.
84+
Ensure that RabbitMQ is deployed with the version you expect by searching for
85+
`Running RabbitMQ (<image>:<image_tag>) with` in `docker logs rabbitmq`.
8286
:::
8387

8488
:::info
85-
To start one specific version of RabbitMQ run the following command instead:
86-
```bash
89+
To start one specific version of RabbitMQ, run this command instead:
90+
```bash
8791
MODE=portal OAUTH_PROVIDER=uaa IMAGE=rabbitmq IMAGE_TAG=<YourVersion> make start-rabbitmq
8892
```
8993
:::
9094

91-
## Deploy Portal
95+
## Deploy Portal
9296

93-
Run the following commands to start Portal:
97+
To start Portal, run:
9498

9599
```bash
96100
make start-portal
97101
```
98102

99-
## Verify Management UI flows
103+
## Verify management UI flows
104+
105+
To verify management UI flows:
100106

101107
1. Go to the portal `https://localhost:3000`.
102-
2. Click on the button `https://localhost:15671 for rabbit_idp_user`.
103-
3. It redirects to RabbitMQ management UI fully authenticated.
108+
2. Click the button **https://localhost:15671 for rabbit_idp_user**, which redirects you to the
109+
RabbitMQ management UI fully authenticated.
104110

105-
:::info
106-
`rabbit_idp_user` is the OAuth Client the portal uses to obtain an access token to
107-
test this flow. This OAuth Client is declared in UAA.
111+
:::info
112+
`rabbit_idp_user` is the OAuth Client the portal uses to obtain an access token to test this flow.
113+
This OAuth Client is declared in UAA.
108114
:::
109115

110116
:::warning
111-
When you visit https://localhost:3000 you will get a browser warning
112-
due to net::ERR_CERT_AUTHORITY_INVALID. This is because the portal
113-
is using a self-signed certificate. You accept it by clicking on `Proceed to localhost (unsafe)`.
117+
When you visit `https://localhost:3000` you get a browser warning because of the error
118+
`net::ERR_CERT_AUTHORITY_INVALID`. This is because the portal is using a self-signed certificate.
119+
Click on `Proceed to localhost (unsafe)` to accept it.
114120
:::

‎versioned_docs/version-3.13/oauth2-examples/index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ management.oauth_provider_url = https://uaa:8443
156156
# ...
157157
```
158158

159-
:::tip
159+
:::tip
160160
You only need to set `management.oauth_provider_url` when you have not configured
161-
`auth_oauth2.issuer` and/or they have different urls.
161+
`auth_oauth2.issuer` and/or they have different URLs.
162162
:::
163163

164164
### Identity-Provider initiated logon {#identity-provider-initiated-logon}
@@ -182,12 +182,12 @@ by submitting a form with their OAuth token in the `access_token` form field as
182182
/|\ |
183183
| |
184184
1. rabbit_admin from a browser <-----3. 302 redirect to RabbitMQ w/cookie--+
185-
185+
186186
```
187187

188-
If the access token is valid, RabbitMQ redirects the user to the **Overview** page with
189-
a cookie which carries the validated token. When RabbitMQ delivers the **Overview** page,
190-
it clears the cookie.
188+
If the access token is valid, RabbitMQ redirects the user to the **Overview** page with
189+
a cookie that carries the validated token. When RabbitMQ delivers the **Overview** page,
190+
it clears the cookie.
191191

192192
By default, the RabbitMQ Management UI is configured with **service-provider initiated logon**, to configure **Identity-Provider initiated logon**, the following configuration entries are required in `rabbitmq.conf`:
193193

@@ -199,9 +199,9 @@ management.oauth_provider_url = http://localhost:8080
199199
# ...
200200
```
201201

202-
:::tip
202+
:::tip
203203
You only need to set `management.oauth_provider_url` when you have not configured
204-
`auth_oauth2.issuer` and/or they have different urls.
204+
`auth_oauth2.issuer` and/or they have different URLs.
205205
:::
206206

207207
**Important**: when the user logs out, or its RabbitMQ session expires, or the token expires, the user is directed to the

0 commit comments

Comments
 (0)