diff --git a/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/archetypes/policy.md b/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/archetypes/policy.md new file mode 100644 index 0000000000..30931254e7 --- /dev/null +++ b/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/archetypes/policy.md @@ -0,0 +1,148 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: {{ .Date }} +# Change draft status to false to publish doc +draft: true +# Description +# Add a short description (150 chars) for the doc. Include keywords for SEO. +# The description text appears in search results and at the top of the doc. +description: "Add a one-sentence description of the doc that'll show up in search results." +# Assign weights in increments of 100 +weight: +toc: true +tags: [ "docs" ] +# Create a new entry in the Jira DOCS Catalog and add the ticket ID (DOCS-) below +docs: "DOCS-000" +# Taxonomies +# These are pre-populated with all available terms for your convenience. +# Remove all terms that do not apply. +categories: ["installation", "platform management", "load balancing", "api management", "security", "analytics"] +doctypes: ["reference"] +journeys: ["researching", "getting started", "using", "renewing", "self service"] +personas: ["devops", "netops", "secops", "support"] +versions: [] +authors: [] +--- + +{{}} + +## Overview + +Write an introduction for the policy. Briefly explain what the policy is for. + +Introduce and explain any new concepts the user may need to understand before proceeding. + +--- + +## Before You Begin + +To complete the steps in this guide, you need the following: + +- API Connectivity Manager is installed, licensed, and running +- You have [one or more Environments with an API Gateway]({{< relref "acm/getting-started/add-api-gateway.md" >}}) +- You have [published one or more API Gateways]({{< relref "acm/getting-started/publish-api-proxy.md" >}}) + +### How to Access the User Interface + +{{< include "acm/how-to/access-acm-ui" >}} + +### How to Access the REST API + +{{< include "acm/how-to/access-acm-api" >}} + +--- + +## Create an XYZ Policy + +{{}} + +{{%tab name="UI"%}} + +To create an XYZ policy using the web interface: + +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**. +2. Add other steps here +3. As a numbered list. + +{{%/tab%}} + +{{%tab name="API"%}} + +To create an XYZ policy using the REST API, send an HTTP `POST` request to the Add-Endpoint-Name-Here endpoint. + +{{< raw-html>}}
{{}} +{{< bootstrap-table "table table-striped table-bordered" >}} +| Method | Endpoint | +|--------|---------------------| +| `POST` | `/path/to/endpoint` | +{{}} +{{< raw-html>}}
{{}} + +
+JSON request + +``` json +{ + "users": [ + { + "id": 1, + "name": "John Doe", + "age": 24 + }, + { + "id": 2, + "name": "Jane Doe", + "age": 28 + } + ] +} +``` + +
+ +
+ +{{< raw-html>}}
{{}} +{{< bootstrap-table "table table-striped table-bordered" >}} +| Field | Datatype | Possible Values | Description | Required | Default | +|--------|----------|---------------------|----------------------------------------------------|----------|-----------------------| +| `id` | integer | A unique int >= 1 | Description for value. | Yes | System assigned | +| `name` | string | Example: `Jane Doe` | A short description of what the field is used for. | Yes | Add the default value | +| `age` | integer | 1–110 | Description for the value | Yes | | + +{{< /bootstrap-table >}} +{{< raw-html>}}
{{}} + +{{%/tab%}} + +{{}} + +--- + +## Verify the Policy + +Confirm that the policy has been set up and configured correctly by taking these steps: + +- Add verification steps here + +--- + +## Troubleshooting + +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. + +### Issue 1 + +Add a description for the issue. Include any error messages users might see. + +Resolution/workaround: + +- Add steps here. + +### Issue 2 + +Add a description for the issue. Include any error messages users might see. + +Resolution/workaround: + +- Add steps here. \ No newline at end of file diff --git a/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/footer.html b/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/footer.html index 1a45ed65a7..883d0006e4 100644 --- a/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/footer.html +++ b/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/footer.html @@ -58,6 +58,7 @@
  • NGINX Open Source
  • NGINX Unit
  • NGINX Amplify
    • +
  • NGINX Agent
  • NGINX Kubernetes Ingress Controller
  • NGINX Microservices Reference Architecture
  • NGINX Crossplane
    • diff --git a/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/meta.html b/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/meta.html index 9fd1bf7d99..13273a9fbb 100644 --- a/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/meta.html +++ b/docs/_vendor/gitlab.com/f5/nginx/controller/poc/f5-hugo/layouts/partials/meta.html @@ -46,17 +46,19 @@ https://static.cloud.coveo.com https://kit.fontawesome.com/ https://*.netlify.app - https://gist.github.com - https://mktg.tags.f5.com/ + https://gist.github.com https://tag.demandbase.com/pscSDsz4.min.js - https://cdn.f5.com https://munchkin.brightfunnel.com/js/build/bf-munchkin.min.js + https://www.googletagmanager.com/gtm.js + https://www.google-analytics.com/ https://www.google-analytics.com/analytics.js https://www.google-analytics.com/plugins/ua/linkid.js https://cdn.bizible.com/scripts/bizible.js https://cdn.bizible.com/xdc.js - https://mktg.aa.f5.com/ https://consent.trustarc.com/ + https://f5networksglobalprod.122.2o7.net/ + https://f5networksnginxdocs.122.2o7.net/ + https://*.f5.com 'unsafe-inline' {{ if in .Params.doctypes "devportal" }} 'unsafe-eval' {{end}}; worker-src 'self' blob:"> diff --git a/docs/_vendor/modules.txt b/docs/_vendor/modules.txt index 3cf010ec97..fb3481a34b 100644 --- a/docs/_vendor/modules.txt +++ b/docs/_vendor/modules.txt @@ -1 +1 @@ -# gitlab.com/f5/nginx/controller/poc/f5-hugo v0.24.1 +# gitlab.com/f5/nginx/controller/poc/f5-hugo v0.25.2 diff --git a/docs/go.mod b/docs/go.mod index 50a651881f..e39f6583db 100644 --- a/docs/go.mod +++ b/docs/go.mod @@ -2,4 +2,4 @@ module github.com/nginxinc/kubernetes-ingress/docs go 1.15 -require gitlab.com/f5/nginx/controller/poc/f5-hugo v0.24.1 // indirect +require gitlab.com/f5/nginx/controller/poc/f5-hugo v0.25.2 // indirect diff --git a/docs/go.sum b/docs/go.sum index c63203d5fc..6302e5bda2 100644 --- a/docs/go.sum +++ b/docs/go.sum @@ -32,3 +32,5 @@ gitlab.com/f5/nginx/controller/poc/f5-hugo v0.24.0 h1:2lkCeWVT7EeJWuXa5pyZvDMYGv gitlab.com/f5/nginx/controller/poc/f5-hugo v0.24.0/go.mod h1:Y9Ez7EKgsbFXNsflK0tGLe6FWqlPToWFGZyrkduYdM4= gitlab.com/f5/nginx/controller/poc/f5-hugo v0.24.1 h1:T7y56NzgU4sJ1ymoWDw8CeZeTyOXJSPY5NwFBBZ/EXA= gitlab.com/f5/nginx/controller/poc/f5-hugo v0.24.1/go.mod h1:Y9Ez7EKgsbFXNsflK0tGLe6FWqlPToWFGZyrkduYdM4= +gitlab.com/f5/nginx/controller/poc/f5-hugo v0.25.2 h1:WYCERTzhAsQRe2iyZn3ui87f8gEapq8rB2xCMXiFxYw= +gitlab.com/f5/nginx/controller/poc/f5-hugo v0.25.2/go.mod h1:Y9Ez7EKgsbFXNsflK0tGLe6FWqlPToWFGZyrkduYdM4=