|
| 1 | +--- |
| 2 | +title: |
| 3 | +# Remove or set to false to turn off the right-hand in-page ToC |
| 4 | +toc: true |
| 5 | +# Add a short description (150 chars or less) for the doc. Include keywords for SEO. |
| 6 | +# The description text appears in search results and at the top of the doc. |
| 7 | +description: "" |
| 8 | +# Assign weights in increments of 100 |
| 9 | +# Lower numbers appear higher in the document list |
| 10 | +weight: |
| 11 | +tags: [ "docs" ] |
| 12 | +--- |
| 13 | + |
| 14 | +## Overview |
| 15 | + |
| 16 | +<!-- |
| 17 | +If your topic is for a global policy, add the following include: |
| 18 | +
|
| 19 | +{{< include "acm/how-to/policies-intro" >}} |
| 20 | +
|
| 21 | +- OR - |
| 22 | +
|
| 23 | +If your topic is for an API GW policy, add this include: |
| 24 | +
|
| 25 | +{{< include "acm/how-to/policies-proxy-intro.md" >}} |
| 26 | +
|
| 27 | +--> |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## About XYZ Policy |
| 32 | + |
| 33 | +<!-- |
| 34 | +Explain what the policy does and what it can be used for. |
| 35 | +--> |
| 36 | + |
| 37 | +#### Intended Audience |
| 38 | + |
| 39 | +<!-- |
| 40 | +Specify the intended audience for this guide, that is, who is responsible for applying and/or configuring the policy? For example, and Infrastructure Administrator. |
| 41 | +--> |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## Workflow for Applying Policy |
| 46 | + |
| 47 | +<!-- |
| 48 | +Add the high-level steps the user must take to apply the policy. For example: |
| 49 | +
|
| 50 | +- Create an environment or edit an existing one. |
| 51 | +- Check the advanced settings for the environment to see if the policy has been applied. |
| 52 | +- Edit the policy to make changes for each environment. Save and publish the changes. |
| 53 | +
|
| 54 | +--> |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Policy Settings |
| 59 | + |
| 60 | +<!-- Update the following table with the policy's params --> |
| 61 | + |
| 62 | +The following table lists the configurable settings and their default values for the policy. |
| 63 | + |
| 64 | + |
| 65 | +{{< bootstrap-table "table table-striped table-bordered" >}} |
| 66 | + |
| 67 | +| Field | Datatype | Possible Values | Description | Required | Default | |
| 68 | +|--------------|----------|---------------------|----------------------------------------------------|----------|-----------------------| |
| 69 | +| `users.id` | integer | A unique int >= 1 | Description for value. | Yes | System assigned | |
| 70 | +| `users.name` | string | Example: `Jane Doe` | A short description of what the field is used for. | Yes | Add the default value | |
| 71 | +| `user.age` | integer | 1–110 | Description for the value | Yes | | |
| 72 | + |
| 73 | +{{< /bootstrap-table >}} |
| 74 | + |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +## Adding XYZ Policy |
| 79 | + |
| 80 | +{{<tabs name="policy-implementation">}} |
| 81 | + |
| 82 | +{{%tab name="API"%}} |
| 83 | + |
| 84 | +{{<see-also>}}{{< include "acm/how-to/access-acm-api.md" >}}{{</see-also>}} |
| 85 | + |
| 86 | +To create an XYZ policy using the REST API, send an HTTP `POST` request to the Add-Endpoint-Name-Here endpoint. |
| 87 | + |
| 88 | + |
| 89 | +{{< bootstrap-table "table table-striped table-bordered" >}} |
| 90 | + |
| 91 | +| Method | Endpoint | |
| 92 | +|--------|---------------------| |
| 93 | +| `POST` | `/path/to/endpoint` | |
| 94 | + |
| 95 | +{{</bootstrap-table>}} |
| 96 | + |
| 97 | + |
| 98 | +<details open> |
| 99 | +<summary>JSON request</summary> |
| 100 | + |
| 101 | +``` json |
| 102 | +{ |
| 103 | + "users": [ |
| 104 | + { |
| 105 | + "id": 1, |
| 106 | + "name": "John Doe", |
| 107 | + "age": 24 |
| 108 | + }, |
| 109 | + { |
| 110 | + "id": 2, |
| 111 | + "name": "Jane Doe", |
| 112 | + "age": 28 |
| 113 | + } |
| 114 | + ] |
| 115 | +} |
| 116 | +``` |
| 117 | + |
| 118 | +</details> |
| 119 | + |
| 120 | +{{%/tab%}} |
| 121 | + |
| 122 | +{{%tab name="UI"%}} |
| 123 | + |
| 124 | +To create an XYZ policy using the web interface: |
| 125 | + |
| 126 | +1. Go to the FQDN for your NGINX Management Suite host in a web browser and log in. Then, from the Launchpad menu, select **API Connectivity Manager**. |
| 127 | +2. Add other steps here |
| 128 | +3. As a numbered list. |
| 129 | + |
| 130 | +{{%/tab%}} |
| 131 | + |
| 132 | +{{</tabs>}} |
| 133 | + |
| 134 | +--- |
| 135 | + |
| 136 | +## Verify the Policy |
| 137 | + |
| 138 | +<!-- |
| 139 | +Add verification instructions to confirm that the policy has been correctly implemented and is being enforced. |
| 140 | +--> |
| 141 | + |
| 142 | +Confirm that the policy has been set up and configured correctly by taking these steps: |
| 143 | + |
| 144 | +- Add steps to verify policy was applied successfully to the the management plane. |
| 145 | + |
| 146 | +Confirm the policy is being enforced: |
| 147 | + |
| 148 | +- Add steps to verify policy is being enforced on the data plane. What can users expect to see? |
| 149 | + |
| 150 | +--- |
| 151 | + |
| 152 | +## Troubleshooting |
| 153 | + |
| 154 | +<!-- Add troubleshooting steps for issues users might encounter and can self-solve. The purpose of this section is to deflect customer calls to Support. --> |
| 155 | + |
| 156 | +For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< relref "support/contact-support.md" >}}) for assistance. |
| 157 | + |
| 158 | +### Issue 1 |
| 159 | + |
| 160 | +Add a description for the issue. Include any error messages users might see. |
| 161 | + |
| 162 | +Resolution/Workaround: |
| 163 | + |
| 164 | +1. Add steps here |
| 165 | +2. As a |
| 166 | +3. numbered list. |
| 167 | + |
| 168 | +### Issue 2 |
| 169 | + |
| 170 | +Add a description for the issue. Include any error messages users might see. |
| 171 | + |
| 172 | +Resolution/Workaround: |
| 173 | + |
| 174 | +1. Add steps here |
| 175 | +2. As a |
| 176 | +3. numbered list. |
0 commit comments