Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix typos, style, and improper links #18269

Merged
merged 1 commit into from
Jul 24, 2023
Merged

fix typos, style, and improper links #18269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 23 additions & 16 deletions website/content/docs/enterprise/license/utilization-reporting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,26 @@ description: >-

# Automated license utilization reporting

Automated license utilization reporting sends license utilization data to HashiCorp without requiring you to manually collect and report them. It also enables you to review your license usage with the monitoring solution you already use, such as Splunk and Datadog, as you optimize and manage your deployments. You can use these reports to understand how much more you can deploy under your current contract, which can help you protect against overutilization and budget for predicted consumption.
This topic describes how to enable automated license utilization reporting in Consul Enterprise. This feature automatically sends license utilization data to HashiCorp so that you do not have to manually collect and report it. It also enables you to review your license usage with the monitoring solution you already use, such as Splunk and Datadog, as you optimize and manage your deployments.

Automated reporting shares the minimum data required to validate license utilization as defined in our contracts. This data mostly consists of computed metrics, and it will never contain Personal Identifiable Information (PII) or other sensitive information. Automated reporting shares the data with HashiCorp using a secure unidirectional HTTPS API and makes an auditable record in the product logs each time it submits a report. This process is GDPR compliant.
## Introduction

You can use automated license utilization report to understand how much additional networking infrastructure you can deploy under your current contract. This feature helps you protect against overutilization and budget for predicted consumption.

Automated reporting shares the minimum data required to validate license utilization as defined in our contracts. This data mostly consists of computed metrics, and it will never contain Personal Identifiable Information (PII) or other sensitive information. Automated reporting shares the data with HashiCorp using a secure unidirectional HTTPS API and makes an auditable record in the product logs each time it submits a report. This process is GDPR-compliant.

## Requirements

Automated license utilization reporting does not support _air-gapped installations_, which are systems with no network interfaces.

The following versions of Consul Enterprise support automated license utilization reporting:

- Consul Enterprise v1.16.0 and newer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Consul Enterprise v1.16.0 and newer.
- Patch releases of Consul Enterprise v1.16.0 and newer.

just so it's consistent

- Patch releases of Consul Enterprise v1.15.4 and newer.
- Patch releases of Consul Enterprise v1.14.8 and newer.
- Patch releases of Consul Enterprise v1.13.9 and newer.

Download a supported release from the [Consul Versions](https://releases.hashicorp.com/consul/) page.

## Enable automated reporting

Expand All @@ -17,27 +34,17 @@ Before you enable automated reporting, make sure that outbound network traffic i
To enable automated reporting, complete the following steps:

1. [Allow outbound HTTPS traffic on port 443](#allow-outbound-https-traffic)
1. Upgrade to Consul Enterprise v1.16.0 or newer (#upgrade-to-consul-enterprise)
1. Check product logs(#check-product-logs)
1. [Check product logs](#check-product-logs)

### Allow outbound HTTPS traffic on port 443

Make sure that your network allows HTTPS egress on port 443 from `https://reporting.hashicorp.services` by allow-listing the following IP addresses:
Make sure that your network allows HTTPS egress on port 443 from `https://reporting.hashicorp.services` by adding the following IP adddresses to your allow-list:

- `100.20.70.12`
- `35.166.5.222`
- `23.95.85.111`
- `44.215.244.1`

### Upgrade to Consul Enterprise v1.16.0 or newer

Upgrade to a release that supports license utilization reporting. These [releases](https://releases.hashicorp.com/consul/) include:

- Consul Enterprise 1.16.0 and newer.
- Consul Enterprise 1.15.4 and newer.
- Consul Enterprise 1.14.8 and newer.
- Consul Enterprise 1.13.9 and newer.

### Check product logs

Automatic license utilization reporting starts sending data within roughly 24 hours. Check the product logs for records that the data sent successfully.
Expand Down Expand Up @@ -77,7 +84,7 @@ If your installation is air-gapped or your network does not allow the correct eg

</CodeBlockConfig>

In this case, reconfigure your network to allow egress and check back in roughly 24 hours.
In this case, reconfigure your network to allow egress and check the logs again in roughly 24 hours to confirm that automated reporting works correctly.

## Opt out

Expand All @@ -102,7 +109,7 @@ reporting {
}
```

When you opt out using an environment variable, once you restart your system it will provide a startup message confirming that you have disabled automated reporting. Set the following environment variable to disable automated reporting:
When opting out using an environment variable, the system provides a startup message confirming that you have disabled automated reporting. Set the following environment variable to disable automated reporting:

<CodeBlockConfig>

Expand Down