Skip to content

Add secrets support to the Azure Logs integration - #9022

Merged
zmoog merged 6 commits into
elastic:mainfrom
zmoog:zmoog/azure-secrets
Feb 7, 2024
Merged

Add secrets support to the Azure Logs integration#9022
zmoog merged 6 commits into
elastic:mainfrom
zmoog:zmoog/azure-secrets

Conversation

@zmoog

@zmoog zmoog commented Jan 31, 2024

Copy link
Copy Markdown
Contributor

Proposed commit message

  • Define the connection_string and storage_account_key variables as secrets.
  • Bump the package-spec version to 3.0.2 (secrets requirement)
  • Bump Kibana version constraints to ^8.12.0 (^8.10.0 to get secrets support, ^8.12.0 to avoid known bugs)

This ensures their values are encrypted and hidden from the settings UI in Kibana, significantly enhancing security.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

How to test this PR locally

Related issues

Screenshots

CleanShot 2024-01-31 at 09 11 12@2x

zmoog added 2 commits January 31, 2024 08:46
Secrets require:

- package-spec 3.0.2
- stack 8.10.0
Define `connection_string` and `storage_account_key` as secrets.
@zmoog zmoog added the enhancement New feature or request label Jan 31, 2024
@zmoog zmoog self-assigned this Jan 31, 2024
zmoog added 3 commits January 31, 2024 09:40
Kibana supports secrets from 8.10.0. However, stack versions in the
8.10.0 - 8.11.2 range have known bugs [^1] on secrets management.

The recommended minimum stack version to use secrets is now 8.11.2.

[^1]: See elastic#8610
With package-spec 3.0.1, the updated validators caught some missing
field mappings.

The missing fields are:

- `azure.auditlogs.properties.additional_details.key`
- `azure.auditlogs.properties.additional_details.value`

The `AuditLogs` docs [^1] don't provide much details about the content
of the `AdditionalDetails` field, reporting its type as `dynamic.`

I am adding these two fields with a generic description for now.

[^1]: https://learn.microsoft.com/en-us/azure/azure-monitor/reference/tables/auditlogs
@elasticmachine

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@zmoog
zmoog marked this pull request as ready for review January 31, 2024 10:04
@zmoog
zmoog requested review from a team as code owners January 31, 2024 10:04
@gizas

gizas commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

@zmoog seeing last email answer that targeted version is ^8.12.0, wondering if you should change it as well

According to the latest recommendations [^1], 8.12.0 contains all the known issues.

[^1]: elastic#8610 (comment)
@elastic-sonarqube

Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No Coverage information No data about Coverage
No Duplication information No data about Duplication

See analysis details on SonarQube

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @zmoog

@zmoog
zmoog merged commit 7b12006 into elastic:main Feb 7, 2024
@zmoog
zmoog deleted the zmoog/azure-secrets branch February 7, 2024 10:50
@elasticmachine

Copy link
Copy Markdown

Package azure - 1.9.0 containing this change is available at https://epr.elastic.co/search?package=azure

@zmoog zmoog changed the title Add secrets support to the Azure Logs integation Apr 16, 2024
@andrewkroh andrewkroh added the Integration:azure Azure Logs label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Integration:azure Azure Logs

6 participants