Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Commit

Permalink
Merge pull request #2389 from aiven/dorota-platform-ux-sync-service-s…
Browse files Browse the repository at this point in the history
…ettings-monitoring-logs-security-networking

platform: sync with ux (service settings page) for networking, security, monitoring, lags sections
  • Loading branch information
wojcik-dorota authored Dec 21, 2023
2 parents 23303af + cdb828a commit cb0732a
Show file tree
Hide file tree
Showing 22 changed files with 110 additions and 135 deletions.
1 change: 1 addition & 0 deletions .github/vale/dicts/aiven.dic
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Apache
API
APIs
ARN
ARNs
Astacus
Auth0
autojoin
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/cloudwatch/cloudwatch-logs-console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Send logs from an Aiven service to AWS CloudWatch

Follow the steps in this section for each of the services whose logs should be sent to AWS CloudWatch.

1. On the **Service Overview** page, select **Manage integrations** and choose the **AWS CloudWatch Logs** option.
1. On the **Overview** page of your service, select **Integrations** and choose the **Amazon CloudWatch Logs** option.

.. image:: /images/integrations/cloudwatch-overview-integrations.png
:alt: Screenshot of system integrations including AWS CloudWatch Logs
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/cloudwatch/cloudwatch-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Send metrics from an Aiven service to AWS CloudWatch

Follow the steps in this section for each of the services whose metrics should be sent to your AWS CloudWatch.

1. From the **Service Overview** page, select **Manage integrations** and choose the **AWS CloudWatch Metrics** option.
1. From the **Overview** page of your service, select **Integrations** and choose the **Amazon CloudWatch Metrics** option.

.. image:: /images/integrations/cloudwatch-overview-integrations.png
:alt: Screenshot of system integrations including AWS CloudWatch Metrics
Expand Down
3 changes: 1 addition & 2 deletions docs/integrations/datadog/add-custom-tags-to-datadog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,10 @@ To add tags to the service integration:

#. Log in to `Aiven Console <https://console.aiven.io/>`_, and select your service.

#. In the service **Overview** page, scroll to **Service integration** and select **Manage integrations**.
#. On the **Overview** page of your service, navigate to the **Service integrations** section and select **Manage integrations**.

#. Next to the Datadog integration listed at the top on the Integrations screen, select **Edit** from the drop-down menu (ellipsis).

#. Enter the desired tags in the provided field. You can add multiple tags by selecting the **Add** icon and optionally include descriptions for each tag.

#. Select **Save configuration** to apply the changes.

2 changes: 1 addition & 1 deletion docs/integrations/datadog/datadog-logs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Send logs from an Aiven service to Datadog

Follow the steps in this section for each of the services whose logs should be sent to Datadog.

1. From the **Service Overview** page, select **Manage integrations** and choose the **Rsyslog** option.
1. On the **Overview** page of your service, select **Integrations** from the sidebar, and select the **Rsyslog** option.

.. image:: /images/integrations/rsyslog-service-integration.png
:alt: Screenshot of system integrations including rsyslog
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/datadog/datadog-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Add Datadog metrics integration to your Aiven service
To enable the Datadog metrics integration for each service that requires metric tracking in Datadog, follow these steps:

1. In the `Aiven Console <https://console.aiven.io/>`_, select your service.
2. In the service **Overview** page, scroll to **Service integrations** and select **Manage integrations**.
3. In the **Integrations** screen, select **Datadog**.
2. From the **Overview** page of your service, scroll to **Service integrations** and select **Manage integrations**.
3. In the **Integrations** screen, select **Datadog Metrics**.

4. Select the Datadog endpoint you want to use from the drop-down list and select **Enable**.

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/prometheus-system-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Get a list of available service metrics

To discover the metrics available for your services, make an HTTP ``GET`` request to your Prometheus service endpoint.

1. Once your Prometheus integration is configured, collect the following Prometheus service details from `Aiven Console <https://console.aiven.io/>`_ > your service's the **Overview** page > the **Connection information** section > the **Prometheus** tab:
1. Once your Prometheus integration is configured, collect the following Prometheus service details from `Aiven Console <https://console.aiven.io/>`_ > the **Overview** page of your service > the **Connection information** section > the **Prometheus** tab:

* Prometheus URL
* Username
Expand Down
7 changes: 2 additions & 5 deletions docs/integrations/rsyslog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,10 @@ Optional:
Add rsyslog integration to service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This can be configured in the Aiven Console by navigating to the target
service overview page and then scrolling down to the **Manage integrations**
button.

This can be configured in the `Aiven Console <https://console.aiven.io/>`_ by navigating to the **Overview** page of the target service > the **Service integrations** section and selecting **Manage integrations**.

You should be able to select your previously configured Rsyslog service
integration by clicking **Use integration** in the modal window.
integration by selecting **Enable** in the modal window.

.. image:: /images/integrations/rsyslog-service-integration.png
:alt: The page that shows the integrations available for a service
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/rsyslog/loggly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ To create a Loggly integration using the `Aiven Console <https://console.aiven.i
* **TLS** - disabled (see below how to enable TLS with avn client)
* **Format** - ``rfc5424``
* **Structured Data** - ``TOKEN@NNNNN TAG="your-tag"`` replacing

* ``TOKEN`` needs to be replaced with your Loggly **customer token** retrieved in the prerequisite stage
* ``NNNNN`` is Loggly Private Enterprise Number (PEN) which is ``41058`` (check `Loggly documentation <https://www.loggly.com/docs/streaming-syslog-without-using-files/>`_ for up to date information)
* ``NNNNN`` is Loggly Private Enterprise Number (PEN) which is ``41058`` (check `Loggly documentation <https://documentation.solarwinds.com/en/success_center/loggly/content/admin/streaming-syslog-without-using-files.htm>`_ for up to date information)
* ``your-tag`` with any arbitrary tag value wrapped in double quotes

.. Tip::
Expand All @@ -60,7 +60,7 @@ After enabling this service integration, it will be shown as active in the `Aive

.. Note::

It may take a few moments to setup the new log, and you can track the status in your service overview.
It may take a few moments to setup the new log, and you can track the status on the **Overview** page of your service > the **Service integrations** section.

Your logs should now be visible on Loggly **Search** tab. Enter the tag name your previously specified (e.g. ``tag:your-tag`` ) and it will populate the dashboard with the log events from the Aiven service.

Expand Down
9 changes: 4 additions & 5 deletions docs/integrations/send-logs-to-elasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,11 @@ Send logs to an external service

#. Navigate to **Services** from the menu on the left.
#. Select the service which logs you want to send to the external Elasticsearch service.
#. On the service *Overview* page scroll to the section *Service integrations*.
#. On the **Overview** page of your service, navigate to the **Service integrations** section.
#. Select **Manage integrations**.
#. Select Elasticsearch from the list.
#. In the newly appeared modal window choose the endpoint with name ``CONNECTION_NAME`` from the list and select **ENABLE**.
#. You can now close the modal window.
#. Observe the status change for newly added integration in the section **Service integrations** on the service overview page.
#. Select **Elasticsearch Logs** from the list.
#. In the newly-appeared modal window, select the endpoint with name ``CONNECTION_NAME`` from the list and select **ENABLE**. Close the modal window.
#. Observe the status change for newly-added integration in the **Service integrations** section on the **Overview** page of your service.
#. Verify that the logs are flowing into your Elasticsearch.

.. note:: Logs are split per day with index name consisting of your desired index prefix and a date in a format year-month-day, for example ``logs-2022-08-30``.
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/concepts/logs-metrics-alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Administrators can configure log and metrics integrations to Aiven services so t
Logs
----

Choose **Manage integrations** from the service overview page to add an integration that will send service logs to an Aiven for OpenSearch® service. This can be an existing service, or you can choose to create a new one.
On the **Overview** page of your service, select **Integrations** to add an integration that will send service logs to an Aiven for OpenSearch® service. This can be an existing service, or you can choose to create a new one.

Metrics
-------

On the service overview page, choose **Manage integrations** to set up an integration to push service metrics to an M3, InfluxDB® or PostgreSQL® service on Aiven. This can be an existing service or you can create a new one to receive the metrics.
On the **Overview** page of your service, select **Integrations** to set up an integration to push service metrics to an M3, InfluxDB® or PostgreSQL® service on Aiven. This can be an existing service or you can create a new one to receive the metrics.

Dashboards
----------
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/tls-ssl-certificates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Most of our services use a browser-recognized CA certificate, but there are exce

- **Aiven for Apache Kafka®** requires the Aiven project CA certificate, and also the client key and certificate.

For these services you can :doc:`/docs/platform/howto/download-ca-cert` from the service overview page.
For these services you can :doc:`/docs/platform/howto/download-ca-cert` from **Overview** page of your service.

.. note::
Older/existing services may be using the Aiven project's CA, you can request switching to a browser-recognized certificate by opening support ticket and letting us know.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,13 @@ Enabling Jolokia integration
------------------------------
To enable Jolokia integration for a specific service, follow these steps:

1. In the `Aiven console <https://console.aiven.io/>`_, open the service for which you want to enable Jolokia integration.
2. In the service **Overview** page, scroll to **Service integrations** and select **Manage integrations**.
3. In the **Integrations** page, select **Jolokia** from the list.
1. In the `Aiven Console <https://console.aiven.io/>`_, open the service for which you want to enable Jolokia integration.
2. On the **Overview** page of your service, navigate to the **Service integrations** section, and select **Manage integrations**.
3. On the **Integrations** page, select **Jolokia** from the list.
4. Select the Jolokia endpoint you created and select **Enable**. The system will configure the Jolokia endpoint on all service nodes, providing access to the metrics.


The Aiven Jolokia integration enables HTTP POST requests to retrieve values from service-specific metrics. It also supports bulk requests for batch collection of metrics. For more detailed information on the Jolokia protocol, refer to `Jolokia
documentation <https://jolokia.org/reference/html/protocol.html>`__ .
documentation <https://jolokia.org/reference/html/manual/jolokia_protocol.html>`__ .

Several metrics are specific to a Kafka® broker. Therefore, you may need to query each node to obtain a comprehensive overview. The node IP is represented by a single DNS name. You can use the ``host`` command on Unix systems or the ``nslookup`` command on Windows systems to retrieve the list of IP addresses associated with a DNS name.

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/integrations/prometheus-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Aiven offers Prometheus endpoints for your services. To enable this feature, tak
Accessing Prometheus in a VPC
''''''''''''''''''''''''''''''

If you use a VPC in your project, to access Prometheus, you need to go to `Aiven Console <https://console.aiven.io/>`_ > your project > the service you want to monitor using Prometheus > the **Overview** page > the **Advanced configuration** section and enable property ``public_access.prometheus``.
If you use a VPC in your project, to access Prometheus, you need to go to `Aiven Console <https://console.aiven.io/>`_ > your project > the service you want to monitor using Prometheus > the **Service settings** page > the **Cloud and network** section > the actions (**...**) menu > the **More network configurations**. In the **Network configuration** window, select **Add configuration options**, search for property ``public_access.prometheus``, enable it, and select **Save configuration**.

Configure Prometheus
--------------------
Expand Down
16 changes: 9 additions & 7 deletions docs/platform/howto/manage-vpc-peering.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,23 +62,25 @@ You can migrate any Aiven service to a different VPC:

#. In `Aiven Console <https://console.aiven.io/>`_, go to your service.

#. On the **Overview** page of your service, go in to **Cloud and VPC** section, click **Migrate cloud**.
#. On the **Overview** page of your service, select **Service settings** from the sidebar.

#. In the **Region** section, select the **VPC** tab.
#. On the **Service settings** page, navigate to the **Cloud and network** section and select **Change cloud or region** from the actions (**...**) menu.

#. Select the VPC that you want to use.

#. Click **Migrate**.
#. In the **Migrate service to another cloud** window > the **Region** section, select the **VPCs** tab, select the VPC that you want to use, and select **Migrate**.

Access VPC services from the public internet
--------------------------------------------

When you move your service to a VPC, access from public networks is blocked by default. If you switch to public access, a separate endpoint is created with a public prefix.
You can enable public Internet access for your services by following the :doc:`Enable public access in a VPC </docs/platform/howto/public-access-in-vpc>` instructions.

IP filtering (the **Allowed IP addresses** list on the service's **Overview** page) is still available for a service deployed to a VPC where both public and private access are allowed. We recommend that you use IP filtering when your VPC service is also exposed to the public internet.
IP filtering (the **Service settings** page > the **Cloud and network** section > the actions (**...**) menu > **Set public IP filters**) is still available for a service deployed to a VPC where both public and private access are allowed. We recommend that you use IP filtering when your VPC service is also exposed to the public internet.

.. note::

**Public IP filters** are restricted via VPC. IP filters apply to publicly-accessible endpoints only.

Also note that safelisting applies to both internal and external traffic. If you safelist an external IP address and want to keep traffic flowing with the internal (peered) connections, make sure that you safelist the CIDR blocks of the peered networks as well to avoid disruptions to the service.
Safelisting applies to both internal and external traffic. If you safelist an external IP address and want to keep traffic flowing with the internal (peered) connections, make sure that you safelist the CIDR blocks of the peered networks as well to avoid disruptions to the service.

Troubleshoot VPC connection issues
----------------------------------
Expand Down
9 changes: 6 additions & 3 deletions docs/platform/howto/public-access-in-vpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ Enable public access in VPCs
To enable public access for a service which is running within a virtual private cloud (VPC), follow these steps:

#. Log in to `Aiven Console <https://console.aiven.io>`_ and select your service from the **Services** page.
#. On the **Overview** page of your service, scroll down to the **Advanced configuration** section and select **Change** > **Add configuration option**.
#. Select an option that starts with ``public_access`` followed by the type of service you use and switch it on.
#. Click **Save advanced configuration**. The **Overview** page now has an **Access Route** setting inside the **Connection information** section with **Public** and **Dynamic** options.
#. On the **Overview** page of your service, select **Service settings** from the sidebar.
#. On the **Service settings** page, navigate to the **Cloud and network** section and select **More network configurations** from the actions (**...**) menu.
#. In the **Network configuration** window, select **Add configuration options**. In the search field, enter ``public_access``. From the displayed parameter names, select a parameter name for your service type. Select the toggle switch to enable the selected parameter. Select **Save configuration**.

The **Overview** page now has an **Access Route** setting inside the **Connection information** section with **Public** and **Dynamic** options.

#. Select **Public** to see the public URL for your service.

The connection with the **Dynamic** option is not possible outside the VPC, while the connection with the **Public** option is accessible over the public Internet. **IP Allow-List** applies to all connection types (Dynamic and Public, in this example).
Expand Down
7 changes: 4 additions & 3 deletions docs/platform/howto/restrict-access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ By default, Aiven services are publicly accessible, but you can restrict access

1. Log in to `Aiven Console <https://console.aiven.io>`_.
2. On the **Services** page, select the service you want to restrict.
3. On the **Overview** page of your service, scroll down to **Allowed IP addresses**, and select **Change**.
4. In the **Allowed inbound IP addresses** window, enter your address or address block using the CIDR notation, and select the **+** icon to add it to the list of the trusted IP addresses.
3. On the **Overview** page of your service, select **Service settings** from the sidebar.
4. On the **Service settings** page, navigate to the **Cloud and network** section and select **Set public IP filters** from the actions (**...**) menu.
5. In the **Allowed inbound IP addresses** window, enter your address or address block using the CIDR notation, and select the **+** icon to add it to the list of the trusted IP addresses.

.. note::

You can add multiple addresses or address blocks or combination of both at once.

5. Select **Close**.
6. Select **Close**.

.. topic:: Result

Expand Down
Loading

0 comments on commit cb0732a

Please sign in to comment.