Skip to content

improvement: NGINX One Console use-case based home page #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
---

With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
In the **Choose Certificate** drop-down, select the managed certificate of your choice, and select **Add**. You can then:

1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair.
Expand Down
23 changes: 23 additions & 0 deletions content/includes/nginx-one/how-to/add-instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
docs:
---

You can add an instance to NGINX One Console in the following ways:

- Directly, under **Instances**
- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**

In either case, NGINX One Console gives you a choice for data plane keys:

- Create a new key
- Use an existing key

NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.

Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.

```bash
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
```

Once the process is complete, you can configure that instance in your NGINX One Console.
2 changes: 1 addition & 1 deletion content/nginx-one/about.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: ''
docs: DOCS-1392
title: About
title: Manage your NGINX fleet
toc: true
weight: 10
type:
Expand Down
4 changes: 2 additions & 2 deletions content/nginx-one/api/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: API
title: Automate with the NGINX One API
description:
weight: 1000
url: /nginx-one/api
---
---
6 changes: 6 additions & 0 deletions content/nginx-one/certificates/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description:
title: Monitor your certificates
weight: 400
url: /nginx-one/certificates
---
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ From the NGINX One Console you can:

You can manage the certificates for:

- [Unique instances]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md#new-ssl-certificate-or-ca-bundle" >}})
- For all instances that are members of a [Config Sync Group]({{< ref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups/#configuration-management" >}})
- [Unique instances]({{< ref "/nginx-one/nginx-configs/add-file.md#new-ssl-certificate-or-ca-bundle" >}})
- For all instances that are members of a [Config Sync Group]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups/#configuration-management" >}})


{{< tip >}}
Expand Down Expand Up @@ -193,5 +193,5 @@ To convert these cerificates to managed, start with the Certificates menu, and s
## See also

- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
- [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}})
- [Add a file in a configuration]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md" >}})
- [Add an instance]({{< ref "/nginx-one/nginx-configs/add-instance.md" >}})
- [Add a file in a configuration]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
10 changes: 5 additions & 5 deletions content/nginx-one/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ You can:
- Remove a deployed certificate from a Config Sync Group

For more information, including warnings about risks, see our documentation on how you can:
- [Add a file]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md" >}})
- [Manage certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}})
- [Add a file]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
- [Manage certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}})

### Revert a configuration

Expand All @@ -108,15 +108,15 @@ From the NGINX One Console you can now:
- Ensure that your certificates are current and correct.
- Manage your certificates from a central location. This can help you simplify operations and remotely update, rotate, and deploy those certificates.

For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}}).
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}}).

## August 22, 2024

### Config Sync Groups

Config Sync Groups are now available in the F5 NGINX One Console. This feature allows you to manage and synchronize NGINX configurations across multiple instances as a single entity, ensuring consistency and simplifying the management of your NGINX environment.

For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md" >}}).
For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups.md" >}}).

## August 8, 2024

Expand All @@ -136,7 +136,7 @@ Select the link for each CVE to see the details, including the CVE's publish dat

### Edit NGINX configurations

You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}}).
You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/nginx-configs/view-edit-nginx-configurations.md" >}}).

## May 28, 2024

Expand Down
6 changes: 6 additions & 0 deletions content/nginx-one/config-sync-groups/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description:
title: Change multiple instances with one push
weight: 400
url: /nginx-one/config-sync-groups
---
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ Enter the name of the desired configuration file, such as `abc.conf` and select
### Existing SSL Certificate or CA Bundle

{{< include "nginx-one/add-file/existing-ssl-bundle.md" >}}
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).

## See also

- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
- [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}})
- [Manage certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}})
- [Add an NGINX instance]({{< ref "/nginx-one/nginx-configs/add-instance.md" >}})
- [Manage certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,6 @@ Now that you created a Config Sync Group, you can add instances to that group. A

Any instance that joins the group afterwards inherits that configuration.

{{< note >}} If you see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**:

- Review the instance details in NGINX One Console to identify any publication problems.
- After you change the configuration of the Config Sync Group, [Publish it](#publish-the-config-sync-group-configuration].
In that case, review and resolve discrepancies between the Instance and the rest of the Config Sync Group. {{< /note >}}

### Add an existing instance to a Config Sync Group {#add-an-existing-instance-to-a-config-sync-group}

You can add existing NGINX instances that are already registered with NGINX One to a Config Sync Group.
Expand Down Expand Up @@ -264,4 +258,4 @@ Monitor the **Config Sync Status** column. It can help you ensure that your conf
## See also

- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
- [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}})
- [Add an NGINX instance]({{< ref "/nginx-one/nginx-configs/add-instance.md" >}})
4 changes: 2 additions & 2 deletions content/nginx-one/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: ''
docs: DOCS-1396
title: Glossary
toc: true
weight: 1000
weight: 2000
type:
- reference
---
Expand All @@ -14,7 +14,7 @@ This glossary defines terms used in the F5 NGINX One Console and F5 Distributed
{{<bootstrap-table "table table-striped table-bordered">}}
| Term | Definition |
|-------------|-------------|
| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
| **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. |
| **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. |
| **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. You'll see the namespace in the NGINX One Console URL as `/namespaces/<namespace name>/` |
Expand Down
2 changes: 1 addition & 1 deletion content/nginx-one/how-to/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description:
title: How-to guides
weight: 200
weight: 700
url: /nginx-one/how-to/
---
6 changes: 0 additions & 6 deletions content/nginx-one/how-to/certificates/_index.md

This file was deleted.

6 changes: 0 additions & 6 deletions content/nginx-one/how-to/config-sync-groups/_index.md

This file was deleted.

6 changes: 0 additions & 6 deletions content/nginx-one/how-to/nginx-configs/_index.md

This file was deleted.

Loading
Loading