Skip to content

Commit

Permalink
Add high level doc for data plane config
Browse files Browse the repository at this point in the history
Problem: As a user, I want to know how I can configure global settings for nginx.

Solution: Add a doc that talks about how global data plane config can be set.
  • Loading branch information
sjberman committed Aug 12, 2024
1 parent 95d64ba commit 9ad7936
Show file tree
Hide file tree
Showing 4 changed files with 114 additions and 28 deletions.
18 changes: 17 additions & 1 deletion .github/workflows/docs-build-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,28 @@ on:
paths:
- "site/**"

concurrency:
group: ${{ github.ref_name }}-docs-push
cancel-in-progress: true

permissions:
contents: read

jobs:
vars:
runs-on: ubuntu-22.04
outputs:
azure_creds: ${{ steps.azure_creds.outputs.defined }}

Check failure on line 32 in .github/workflows/docs-build-push.yml

View workflow job for this annotation

GitHub Actions / Actionlint

[actionlint] reported by reviewdog 🐶 property "azure_creds" is not defined in object type {} [expression] Raw Output: .github/workflows/docs-build-push.yml:32:24: property "azure_creds" is not defined in object type {} [expression]
steps:
- name: "Check if variable is set"
env:
AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS_DOCS }}
if: "${{ env.AZURE_CREDENTIALS != '' }}"
run: echo "::set-output name=defined::true"

Check failure on line 38 in .github/workflows/docs-build-push.yml

View workflow job for this annotation

GitHub Actions / Actionlint

[actionlint] reported by reviewdog 🐶 workflow command "set-output" was deprecated. use `echo "{name}={value}" >> $GITHUB_OUTPUT` instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions [deprecated-commands] Raw Output: .github/workflows/docs-build-push.yml:38:12: workflow command "set-output" was deprecated. use `echo "{name}={value}" >> $GITHUB_OUTPUT` instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions [deprecated-commands]

call-docs-build-push:
if: ${{ github.event.repository.fork == false }}
needs: [vars]
if: ${{ github.event.repository.fork == false && needs.vars.outputs.azure_creds == 'true' }}
uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@03a9a3808fcb77cd0c19d7fa5d59b25565dd1d6d # v1.0.2
permissions:
pull-requests: write # needed to write preview url comment to PR
Expand Down
32 changes: 6 additions & 26 deletions site/content/how-to/control-plane-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs: "DOCS-1416"
---

Learn how to dynamically update the Gateway Fabric control plane configuration.
Learn how to dynamically update the NGINX Gateway Fabric control plane configuration.

## Overview

Expand All @@ -22,42 +22,22 @@ If the resource is invalid to the OpenAPI schema, the Kubernetes API server will

Additionally, the control plane updates the status of the resource (if it exists) to reflect whether it is valid or not.

### Spec

{{< bootstrap-table "table table-striped table-bordered" >}}
| name | description | type | required |
|---------|-----------------------------------------------------------------|--------------------------|----------|
| logging | Logging defines logging related settings for the control plane. | [logging](#speclogging) | no |
{{< /bootstrap-table >}}

### Spec.Logging

{{< bootstrap-table "table table-striped table-bordered" >}}
| name | description | type | required |
|-------|------------------------------------------------------------------------|--------|----------|
| level | Level defines the logging level. Supported values: info, debug, error. | string | no |
{{< /bootstrap-table >}}
**For a full list of configuration options that can be set, see the `NginxGateway spec` in the [API reference]({{< relref "reference/api.md" >}}).**

## Viewing and Updating the Configuration

{{< note >}} For the following examples, the name `nginx-gateway-config` should be updated to the name of the resource created for your installation. {{< /note >}}
{{< note >}} For the following examples, the name `ngf-config` should be updated to the name of the resource created for your installation.{{< /note >}}

To view the current configuration:
To view the current configuration and its status:

```shell
kubectl -n nginx-gateway get nginxgateways nginx-gateway-config -o yaml
kubectl -n nginx-gateway describe nginxgateways ngf-config
```

To update the configuration:

```shell
kubectl -n nginx-gateway edit nginxgateways nginx-gateway-config
kubectl -n nginx-gateway edit nginxgateways ngf-config
```

This will open the configuration in your default editor. You can then update and save the configuration, which is applied automatically to the control plane.

To view the status of the configuration:

```shell
kubectl -n nginx-gateway describe nginxgateways nginx-gateway-config
```
90 changes: 90 additions & 0 deletions site/content/how-to/data-plane-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: "Data plane configuration"
weight: 400
toc: true
docs: "DOCS-000"
---

Learn how to dynamically update the NGINX Gateway Fabric global data plane configuration.

## Overview

NGINX Gateway Fabric can dynamically update the global data plane configuration without restarting. The data plane configuration is a global configuration for nginx that has options that are not available using the standard Gateway API resources. This includes such things as setting an OpenTelemetry collector config, disabling http2, or changing the IP family.

The data plane configuration is stored in the NginxProxy custom resource, which is a cluster-scoped resource that is attached to the `nginx` GatewayClass.

By default, the NginxProxy resource is not created when installing NGINX Gateway Fabric. However, you can set configuration options in the `nginx.config` Helm values, and the resource will be created and attached when NGINX Gateway Fabric is installed using Helm. You can also [manually create and attach](#manually-creating-the-configuration) the resource after NGINX Gateway Fabric is already installed.

If installed using the Helm chart, the NginxProxy resource is named `<release-name>-proxy-config`.

**For a full list of configuration options that can be set, see the `NginxProxy spec` in the [API reference]({{< relref "reference/api.md" >}}).**

{{<note>}}Some global configuration also requires an [associated policy]({{< relref "overview/custom-policies.md" >}}) to fully enable a feature (such as [tracing]({{< relref "/how-to/monitoring/tracing.md" >}}), for example).{{</note>}}

## Viewing and Updating the Configuration

If the `NginxProxy` resource already exists, you can view and edit it.

{{< note >}} For the following examples, the name `ngf-proxy-config` should be updated to the name of the resource created for your installation.{{< /note >}}

To view the current configuration:

```shell
kubectl describe nginxproxies ngf-proxy-config
```

To update the configuration:

```shell
kubectl edit nginxproxies ngf-proxy-config
```

This will open the configuration in your default editor. You can then update and save the configuration, which is applied automatically to the data plane.

To view the status of the configuration, check the GatewayClass that it is attached to:

```shell
kubectl describe gatewayclasses nginx
```

If everything is valid, the `ResolvedRefs` condition should be `True`. Otherwise, you will see an `InvalidParameters` condition in the status.

## Manually Creating the Configuration

If the `NginxProxy` resource doesn't exist, you can create it and attach it to the GatewayClass.

The following command creates a basic `NginxProxy` configuration that sets the IP family to `ipv4` instead of the default value of `dual`:

```yaml
kubectl apply -f - <<EOF
apiVersion: gateway.nginx.org/v1alpha1
kind: NginxProxy
metadata:
name: ngf-proxy-config
spec:
ipFamily: ipv4
EOF
```

Now we need to attach it to the GatewayClass:

```shell
kubectl edit gatewayclass nginx
```

This will open your default editor, allowing you to add the following to the `spec`:

```yaml
parametersRef:
group: gateway.nginx.org
kind: NginxProxy
name: ngf-proxy-config
```
After updating, you can check the status of the GatewayClass to see if the configuration is valid:
```shell
kubectl describe gatewayclasses nginx
```

If everything is valid, the `ResolvedRefs` condition should be `True`. Otherwise, you will see an `InvalidParameters` condition in the status.
2 changes: 1 addition & 1 deletion site/content/how-to/upgrade-apps-without-downtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Upgrade applications without downtime"
weight: 400
weight: 500
toc: true
docs: "DOCS-1420"
---
Expand Down

0 comments on commit 9ad7936

Please sign in to comment.