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

Commit

Permalink
Merge branch 'main' into staceys-jumpcloud-saml-doc-94
Browse files Browse the repository at this point in the history
staceysalamon-aiven authored Feb 27, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents 03bf613 + d101097 commit 7c3bab7
Showing 4 changed files with 96 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .github/vale/styles/Aiven/capitalization_headings.yml
Original file line number Diff line number Diff line change
@@ -24,6 +24,7 @@ exceptions:
- Cassandra
- ClickHouse
- CloudWatch
- Cloud Logging
- Connect
- Connector
- Confluent Avro
@@ -43,8 +44,9 @@ exceptions:
- GitHub
- Go
- Google BigQuery
- Google Cloud Platform
- Google Cloud Logging
- Google Cloud Marketplace
- Google Cloud Platform
- Google Cloud Storage
- Google Cloud SQL
- Google Data Studio
4 changes: 3 additions & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
@@ -147,7 +147,7 @@ entries:
- file: docs/integrations/datadog/datadog-metrics
- file: docs/integrations/datadog/datadog-logs
- file: docs/integrations/cloudwatch
title: Amazon CloudWatch
title: Amazon CloudWatch
entries:
- file: docs/integrations/cloudwatch/cloudwatch-metrics
title: CloudWatch Metrics
@@ -156,6 +156,8 @@ entries:
entries:
- file: docs/integrations/cloudwatch/cloudwatch-logs-console
- file: docs/integrations/cloudwatch/cloudwatch-logs-cli
- file: docs/integrations/cloudlogging
title: Google Cloud Logging
- file: docs/integrations/rsyslog
title: RSyslog
entries:
83 changes: 83 additions & 0 deletions docs/integrations/cloudlogging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
Google Cloud Logging
====================

You can send your service logs to Google Cloud Logging to store, search, analyze, monitor, and alert on log data from your Aiven services.

There are two steps to setting up this integration:

1. Create the Google Cloud Logging integration

2. Create the integration endpoint

You can do this using either the `Aiven Console <https://console.aiven.io/>`_ or the :doc:`CLI </docs/tools/cli>`.

Prerequisites
--------------
* You have a Google Project ID and Log ID. More information about Google Cloud projects is available in the `Google Cloud documentation <https://cloud.google.com/resource-manager/docs/creating-managing-projects>`_.
* You have Google Cloud service account credentials in JSON format to authenticate with the Google Cloud Platform. See Google Cloud's documentation for `instructions on how to create and get service account credentials <https://developers.google.com/workspace/guides/create-credentials>`_.
* The service account has permission to create log entries. See the Google Cloud documentation for information on `access control with IAM <https://cloud.google.com/logging/docs/access-control>`_.

Set up Cloud Logging integration in Aiven Console
--------------------------------------------------

Step 1. Create the integration endpoint
""""""""""""""""""""""""""""""""""""""""

#. Go to **Integration Endpoints**.

#. Select **Google Cloud Logging**.

#. Click **Add new endpoint**.

#. Enter a name.

#. Enter the **GCP Project ID** and **Log ID** from Google Cloud.

#. Enter the **Google Service Account Credentials** in JSON format.

#. Click **Create**.

Step 2. Add the integration endpoint to your service
"""""""""""""""""""""""""""""""""""""""""""""""""""""

#. Go to the service you want to add the logs integration to.

#. Select the **Integrations** tab.

#. Select **Google Cloud Logging**.

#. Choose the endpoint that you created.

#. Click **Enable**.


Set up Cloud Logging integration using the CLI
-----------------------------------------------

Step 1. Create the integration endpoint
""""""""""""""""""""""""""""""""""""""""

.. code::
avn service integration-endpoint-create --project your-project-name \
-d "Google Cloud Logging" -t external_google_cloud_logging \
-c project_id=your-gcp-project-id \
-c log_id=my-aiven-service-logs \
-c service_account_credentials='{"type": "service_account"...}
Step 2. Add the integration endpoint to your service
"""""""""""""""""""""""""""""""""""""""""""""""""""""

1. Get the endpoint identifier:

.. code-block:: shell
avn service integration-endpoint-list --project your-project-name
2. Use the ``endpoint_id`` to attach the service to the endpoint:

.. code-block:: shell
avn service integration-create --project your-project-name \
-t external_google_cloud_logging -s your-service \
-D <ENDPOINT_ID>
8 changes: 7 additions & 1 deletion docs/platform/concepts/maintenance-window.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Maintenance window
===========================
==================

The **maintenance window** is a time window during which the nodes behind Aiven services are switched to new upgraded version and, once the process is completed, the overall URI DNS name is pointed at the new location.

@@ -17,3 +17,9 @@ In case of **Apache Kafka®** and **OpenSearch®** the service DNS address resol
.. Note::

While the DNS name remains the same, the IP address it points to, will change during a maintenance break. To know more about static IP addresses, check the :doc:`related documentation <static-ips>`.


Maintenance updates
~~~~~~~~~~~~~~~~~~~

Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week.

0 comments on commit 7c3bab7

Please sign in to comment.