Skip to content

Commit d8ae075

Browse files
committed
feature: define Staged Configs
1 parent 6a2c2be commit d8ae075

File tree

7 files changed

+154
-2
lines changed

7 files changed

+154
-2
lines changed

content/nginx-one/glossary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This glossary defines terms used in the F5 NGINX One Console and F5 Distributed
2020
| **Data Plane** | The data plane is the part of a network architecture that carries user traffic. It handles tasks like forwarding data packets between devices and managing network communication. In the context of NGINX, the data plane is responsible for tasks such as load balancing, caching, and serving web content. |
2121
| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One, you need to use a data plane key. |
2222
| **Namespace** | In F5 Distributed Cloud, a namespace groups a tenant’s configuration objects, similar to administrative domains. Every object in a namespace must have a unique name, and each namespace must be unique to its tenant. This setup ensures isolation, preventing cross-referencing of objects between namespaces. |
23+
| **Staged Configurations** | A staged configuration allows you to save "work in progress." You can create it from scratch, an instance, or a Config Sync Group. It does _not_ have to be a working configuration until you publish it to an instance or a Config Sync Group. |
2324
| **Tenant** | A tenant in F5 Distributed Cloud is an entity that owns a specific set of configuration and infrastructure. It is fundamental for isolation, meaning a tenant cannot access objects or infrastructure of other tenants. Tenants can be either individual or enterprise, with the latter allowing multiple users with role-based access control (RBAC). |
2425
{{</bootstrap-table>}}
2526

content/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ title: View and edit NGINX configurations
88
toc: true
99
weight: 300
1010
---
11+
<!-- Possible future include, with similar files in config-sync-groups/ and staged-configs/ subdirectories -->
1112

12-
Once you've registered your NGINX instances with the F5 NGINX One Console, you can view and edit their NGINX configurations on the **Instances** details page.
13+
Once you've registered your NGINX Instances with the F5 NGINX One Console, you can view and edit their NGINX configurations on the **Instances** details page.
1314

1415
To view and edit an NGINX configuration, follow these steps:
1516

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Staged Configurations
4+
weight: 800
5+
url: /nginx-one/how-to/staged-configs
6+
---
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
# We use sentence case and present imperative tone
3+
title: Add a Staged Configuration
4+
# Weights are assigned in increments of 100: determines sorting order
5+
weight: i00
6+
# Creates a table of contents and sidebar, useful for large documents
7+
toc: true
8+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9+
type: tutorial
10+
# Intended for internal catalogue and search, case sensitive:
11+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12+
product:
13+
# Intended for internal catalogue
14+
docs: "DOCS-000"
15+
---
16+
17+
## Overview
18+
19+
This guide explains how to add a **Staged Configuration** to your NGINX One Console.
20+
21+
## Before you start
22+
23+
Before you add a **Staged Configuration** to NGINX One Console, ensure:
24+
25+
- You have administrator access to NGINX One Console.
26+
27+
## Add a Staged Configuration
28+
29+
You can add a **Staged Configuration** from:
30+
31+
- Empty files
32+
- An existing Instance
33+
- An existing Config Sync Group
34+
- An existing Staged Config
35+
36+
To start the process from NGINX One Console, select **Manage > Staged Configruations**. Select **Add Staged Configuration**.
37+
38+
The following sections start from the **Add Staged Configuration** window that appears.
39+
40+
### Start from empty files
41+
42+
To start a new Staged Configuration:
43+
44+
1. Select New.
45+
1. Enter a name.
46+
1. Select **Next**.
47+
48+
You will see a new Staged Configuration with the default NGINX configuration file, `/etc/nginx/nginx.conf`, in edit mode.
49+
1. Type or paste content for `/etc/nginx/nginx.conf`.
50+
1. Select **Add File** to add the configuration, certificate, or other file(s) of your choice.
51+
52+
### Start from an existing Instance
53+
54+
To start from an existing Instance:
55+
56+
1. Select From.
57+
1. Select Instance.
58+
1. In the Choose Instance menu that appears, select an existing Instance.
59+
1. Enter a name for your new Staged Configuration.
60+
1. Select Next.
61+
62+
NGINX One Console imports the configuration from the existing Instance. You can now edit the configuration. When you're ready to stop, select Save.
63+
64+
### Start from an existing Config Sync Group
65+
66+
To start from an existing Config Sync Group:
67+
68+
1. Select From.
69+
1. Select Config Sync Group.
70+
1. In the Choose Config Sync Group menu that appears, select an existing Config Sync Group.
71+
1. Enter a name for your new Staged Configuration.
72+
1. Select Next.
73+
74+
NGINX One Console imports the configuration from the existing Config Sync Group. You can now edit the configuration. When you're ready to stop, select Save.
75+
76+
### Start from an existing Staged Config
77+
78+
To start from an existing Staged Config:
79+
80+
1. Select From.
81+
1. Select Staged Config.
82+
1. In the Choose Staged Config menu that appears, select an existing Staged Config.
83+
1. Enter a name for your new Staged Configuration.
84+
1. Select Next.
85+
86+
NGINX One Console imports the configuration from the existing Staged Config. You can now edit the configuration. When you're ready to stop, select Save.
87+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
# We use sentence case and present imperative tone
3+
title: Use an API to Add a Staged Configuration
4+
# Weights are assigned in increments of 100: determines sorting order
5+
weight: 300
6+
# Creates a table of contents and sidebar, useful for large documents
7+
toc: true
8+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9+
type: tutorial
10+
# Intended for internal catalogue and search, case sensitive:
11+
product: NGINX One
12+
# Intended for internal catalogue
13+
docs: "DOCS-000"
14+
---
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
# We use sentence case and present imperative tone
3+
title: View and edit a staged configuration
4+
# Weights are assigned in increments of 100: determines sorting order
5+
weight: 200
6+
# Creates a table of contents and sidebar, useful for large documents
7+
toc: true
8+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9+
type: tutorial
10+
# Intended for internal catalogue and search, case sensitive:
11+
product: NGINX One
12+
# Intended for internal catalogue
13+
docs: "DOCS-000"
14+
---
15+
16+
## Overview
17+
18+
This guide explains how to edit an existing **Staged Configuration** in your NGINX One Console.
19+
20+
## Before you start
21+
22+
Before you edit a **Staged Configuration**, ensure:
23+
24+
- You have administrator access to NGINX One Console.
25+
26+
## View and edit a Staged Configuration
27+
<!-- Possible future include, with similar files in config-sync-groups/, nginx-configs/, and staged-configs/ subdirectories -->
28+
29+
Once you've registered your NGINX Staged Configs with the F5 NGINX One Console, you can view and edit their NGINX configurations on the **Staged Configs** details page.
30+
31+
To view and edit an NGINX configuration, follow these steps:
32+
33+
1. On the left menu, select **Staged Configs**.
34+
2. Select the staged configuration you want to view or modify.
35+
3. Select the **Configuration** tab to see the current configuration for the NGINX instance.
36+
4. Select **Edit Configuration** to make changes to the current configuration.
37+
5. Make your changes to the configuration files. The configuration analyzer will let you know if there are any errors.
38+
6. When you are satisfied with the changes, select **Next**.
39+
7. Compare and verify your changes before selecting **Save and Publish** to publish the edited configuration.
40+
41+
## See also
42+
43+
- [Manage Config Sync Groups]({{< relref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md" >}})

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ module github.com/nginxinc/docs
22

33
go 1.19
44

5-
require github.com/nginxinc/nginx-hugo-theme v0.42.1 // indirect
5+
require github.com/nginxinc/nginx-hugo-theme v0.42.1 // indirect

0 commit comments

Comments
 (0)