Skip to content

Commit 9eb3726

Browse files
committed
Update documentation
Add stub status or REST API prerequisite
1 parent 5ff9b63 commit 9eb3726

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,13 +222,14 @@ modules:
222222

223223
# Install NGINX Amplify.
224224
# Use your NGINX Amplify API key.
225+
# Requires access to either the NGINX stub status or the NGINX Plus REST API.
225226
# Default is null.
226227
amplify_enable: false
227228
amplify_key: null
228229

229230
# Install NGINX Controller.
230231
# Use your NGINX Controller API key and NGINX Controller API endpoint.
231-
# Requires NGINX Plus.
232+
# Requires NGINX Plus and write access to the NGINX Plus REST API.
232233
# Default is null.
233234
controller_enable: false
234235
controller_api_key: null
@@ -326,6 +327,8 @@ This is a sample playbook file for deploying the Ansible Galaxy NGINX role in a
326327
- role: nginxinc.nginx
327328
vars:
328329
type: plus
330+
rest_api_enable: true
331+
rest_api_write: true
329332
controller_enable: true
330333
controller_api_key: <API_KEY_HERE>
331334
controller_api_endpoint: https://<FQDN>/1.4

defaults/main.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,14 @@ modules:
5555

5656
# Install NGINX Amplify.
5757
# Use your NGINX Amplify API key.
58+
# Requires access to either the NGINX stub status or the NGINX Plus REST API.
5859
# Default is null.
5960
amplify_enable: false
6061
amplify_key: null
6162

6263
# Install NGINX Controller.
6364
# Use your NGINX Controller API key and NGINX Controller API endpoint.
64-
# Requires NGINX Plus.
65+
# Requires NGINX Plus and write access to the NGINX Plus REST API.
6566
# Default is null.
6667
controller_enable: false
6768
controller_api_key: null

0 commit comments

Comments
 (0)