docs: NGINXaaS for GC docs improvements

content/_index.md

@@ -46,4 +46,7 @@ Learn how to deliver, manage, and protect your applications using F5 NGINX produ
   {{<card title="F5 NGINXaaS for Azure" titleUrl="/nginxaas/azure/" brandIcon="F5-NGINXaaS-icon.svg" isLanding="true">}}
     Infrastructure-as-a-Service (IaaS) version of NGINX Plus for your Microsoft Azure application stack.
   {{</card >}}
+  {{<card title="F5 NGINXaaS for Google Cloud" titleUrl="/nginxaas/google/" brandIcon="F5-NGINXaaS-icon.svg" isLanding="true">}}
+    Managed NGINX service for your Google Cloud application stack.
+  {{</card >}}
 {{</card-section>}}

content/includes/nginxaas-google/create-or-import-nginx-config.md

@@ -11,7 +11,7 @@ In the NGINXaaS Console,
    - Select **New configuration** to create a new config.
       - Provide a name for your configuration and an optional description.
       - Change the configuration path if needed.
-      - Select to start with the "NGINXaaS Default" (a basic NGINX setup) or an empty configuration file.
+      - Select to start with the "F5 NGINXaaS Default" (a basic NGINX setup) or an empty configuration file.
       - Select **Next**.
    - Select **Copy existing configuration** to use one of the existing configuration files in your account as template.
       - Provide a name for your configuration and an optional description.
@@ -22,3 +22,5 @@ In the NGINXaaS Console,
 
 1. Modify the configuration file as needed and select **Save**.
    - You can import certificates using the **Add file** option.
+
+{{< call-out "warning" >}} If you are not using the "F5 NGINXaaS Default", or if making modifications to the config, please be aware of the [NGINX configuration required content]({{< ref "nginxaas-google/getting-started/nginx-configuration/overview.md#nginx-configuration-required-content" >}}) which must be included. {{< /call-out >}}

content/includes/nginxaas-google/update-nginx-config.md

@@ -11,4 +11,6 @@ nd-docs: DOCS-000
 1. Modify the configuration file(s) as needed and select **Next**.
 1. Review the changes using the "Inline" or "Side-by-side"  views and select **Save**.
 
-You will see a notification confirming that the configuration was updated successfully.
+You will see a notification confirming that the configuration was updated successfully.
+
+{{< call-out "warning" >}} When updating a NGINX config, please be aware of the [NGINX configuration required content]({{< ref "nginxaas-google/getting-started/nginx-configuration/overview.md#nginx-configuration-required-content" >}}) which must be included. {{< /call-out >}}

content/nginxaas-google/changelog.md

@@ -28,7 +28,7 @@ To learn more, refer to the following resources:
 - **Product Information:**
 
     - [F5 NGINXaaS for Google Cloud](https://www.f5.com/products/nginx/f5-nginxaas-for-google-cloud)
-    - [Overview and architecture]({{< ref "/nginxaas-google/overview/overview.md" >}})
+    - [Overview and architecture]({{< ref "/nginxaas-google/overview.md" >}})
     - [Getting Started]({{< ref "/nginxaas-google/getting-started/prerequisites/" >}})
 
 - **Blogs:** [F5 NGINXaaS for Google Cloud: Delivering resilient, scalable applications ](https://f5.com/company/blog/delivering-resilient-scalable-applications.html)
@@ -43,5 +43,5 @@ Visit the Google Cloud Marketplace and start leveraging NGINXaaS for Google Clou
 
    NGINXaaS for Google Cloud is now available in Early Access. This offering provides a fully managed, scalable, and secure solution for deploying and managing NGINX instances on Google Cloud.
 
-   - To learn more about NGINXaaS for Google Cloud, see the [Overview and architecture]({{< ref "/nginxaas-google/overview/overview.md" >}}) topic.
+   - To learn more about NGINXaaS for Google Cloud, see the [Overview and architecture]({{< ref "/nginxaas-google/overview.md" >}}) topic.
    - To deploy NGINXaaS, see the [Getting Started]({{< ref "/nginxaas-google/getting-started/prerequisites/" >}}) guide.

content/nginxaas-google/getting-started/nginx-configuration/overview.md

@@ -19,6 +19,41 @@ NGINX configurations can be uploaded to your NGINXaaS for Google Cloud deploymen
 
 The topics below provide information on NGINX configuration restrictions and directives that are supported by NGINXaaS for Google Cloud when using any of the above workflows.
 
+## NGINX configuration required content
+
+F5 NGINXaaS for Google Cloud requires a few specific configuration statements to be included in order for the NGINXaaS deployment to function properly when applied. All of these are included in the "F5 NGINXaaS Default" config, which is the recommended starting config to create.
+
+1. There must be an http server block (which can be referenced via `include` statement) with the following contents:
+
+    ```nginx
+      server {
+        listen 49151;
+        access_log off;
+        location /api {
+            api write=on;
+            allow 127.0.0.1;
+            deny all;
+        }
+        location /ready {
+            return 200;
+        }
+      }
+    ```
+
+    This server block enables NGINXaaS to access the [NGINX Plus monitoring API]({{< ref "nginx/admin-guide/monitoring/live-activity-monitoring.md" >}}) for constant monitoring of the NGINXaaS deployment's health and collection of metrics. It also exposes a simple readiness endpoint for NGINXaaS to regularly validate the availability of the NGINXaaS deployment. Without this content, a deployment using this config will likely report an unhealthy or failed status.
+
+1. The following top-level NGINX directives must exactly match these configuration settings:
+
+    ```nginx
+    user nginx;
+    worker_processes auto;
+    pid /run/nginx/nginx.pid;
+    ```
+
+NGINXaaS deployments must run as the `nginx` user for proper functionality and security.
+`worker_processes` should be explicitly set to `auto` to guarantee optimal performance at any deployment scale.
+
+Using any other file path for the  `pid` directive may result in a failure to apply the config.
 
 ## NGINX filesystem restrictions
 

content/nginxaas-google/known-issues.md

@@ -10,3 +10,5 @@ url: /nginxaas/google/known-issues/
 List of known issues in the latest release of F5 NGINXaaS for Google Cloud (NGINXaaS).
 
 _There are currently no known issues._
+
+{{< call-out "note" >}} You may also want to be familiar with the documented [NGINXaaS limitations]({{< ref "nginxaas-google/overview.md#limitations" >}}). {{< /call-out >}}

content/nginxaas-google/overview/overview.md → content/nginxaas-google/overview.md

@@ -3,7 +3,7 @@ title: Overview and architecture
 weight: 100
 toc: true
 nd-docs: DOCS-000
-url: /nginxaas/google/overview/overview/
+url: /nginxaas/google/overview/
 type:
 - concept
 ---
@@ -60,10 +60,11 @@ NGINXaaS for Google Cloud is supported in the following regions per geography:
 
 ## Limitations
 
-- We currently support two geographies with limited regions only.
+- As mentioned above, we currently support two geographies with limited regions only.
 - We only support authentication via Google acting as an identity provider.
-- User Role Based Access Control (RBAC) is not supported.
-- NGINX Configuration needs a specific snippet for an NGINXaaS deployment to work.
+- User Role Based Access Control (RBAC) is not yet supported.
+- NGINX Configurations require a specific snippet for an NGINXaaS deployment to work.
+   - For specifics see [NGINX configuration required content]({{< ref "nginxaas-google/getting-started/nginx-configuration/overview.md#nginx-configuration-required-content" >}}).
 
 ## What's next