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.

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

Update docs to reflect that activity log cannot be disabled on Vault Enterprise #29144

Merged
merged 5 commits into from
Dec 17, 2024
Merged
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
10 changes: 10 additions & 0 deletions website/content/api-docs/system/internal-counters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1037,6 +1037,16 @@ The `/sys/internal/counters/config` endpoint is used to configure logging of act
- `enabled` `(string: enable, disable, default)` - Enable or disable counting of client activity. When set to `default`, the client
counts are enabled on Enterprise builds and disabled on community builds. Disabling the feature during the middle of a month will
discard any data recorded for that month, but does not delete previous months.
<Note>

<EnterpriseAlert product="vault" inline />

License utilization cannot be reported if client counting is disabled.

As of 1.16.0, 1.15.6 and 1.14.10, client counting cannot be disabled as manual license utilization reporting is always enabled.

As of 1.14.0, 1.13.4, 1.12.8 and 1.11.12, client counting cannot be disabled when automated license utilization reporting is enabled.
</Note>
- `retention_months` `(integer: 48)` - The number of months of history to retain. The minimum is 48 months and the maximum is 60 months.

Any missing parameters are left at their existing value.
Expand Down
6 changes: 6 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.11.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ an Elasticsearch version prior to 6, they will need to switch back to the old
API path by setting the [bool config option](/vault/api-docs/secret/databases/elasticdb#use_old_xpack)
`use_old_xpack=true`.

## Activity Log Changes

### Disable client counting activity

License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.11.12 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled.

## Changes

@include 'pgx-params.mdx'
Expand Down
6 changes: 6 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.12.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ processes were killed after a successful mount and then respawned when a
request is routed to them. Vault 1.12.0 introduced auto mutual TLS for
secrets/auth plugins so we do not lazy load them on startup anymore.

### Activity Log Changes

#### Disable client counting activity

License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.12.8 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled.

## Known issues

### Pinning to builtin plugin versions may cause failure on upgrade
Expand Down
6 changes: 6 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.13.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ are unaffected.

@include 'application-of-sentinel-rgps-via-identity-groups.mdx'

### Activity Log Changes

#### Disable client counting activity

License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.13.4 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled.

## Known issues

@include 'tokenization-rotation-persistence.mdx'
Expand Down
10 changes: 10 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.14.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ is measuring cumulative time writing, and not the distribution of individual wri

@include 'application-of-sentinel-rgps-via-identity-groups.mdx'

### Activity Log Changes

#### Disable client counting activity

License utilization cannot be reported if client counting is disabled.

As of Vault Enterprise 1.14.10 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled.

As of Vault Enterprise 1.14.0 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint when automated license utilization reporting is enabled.

## Known issues and workarounds

@include 'known-issues/ui-pki-control-groups.mdx'
Expand Down
6 changes: 6 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.15.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ kubectl exec -ti <NAME> -- wget https://github.com/moparisthebest/static-curl/re

**NOTE:** When using this option you'll want to verify that the static binary comes from a trusted source.

## Activity Log Changes

### Disable client counting activity

License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.15.6 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled.

## Known issues and workarounds

@include 'known-issues/1_15-auto-upgrade.mdx'
Expand Down
4 changes: 4 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.16.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ decides to trigger the flag. More information can be found in the

### Activity Log Changes

#### Disable client counting activity

License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.16.0 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled.

#### Default Activity Log Querying Period

As of 1.16.13 and later, the field `default_report_months` can no longer be configured or read. Any previously set values
Expand Down
13 changes: 13 additions & 0 deletions website/content/partials/faq/client-count/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,19 @@ and disable the tracking parameter. If you disable client counting in the middle
of a month, Vault will discard any data currently recorded for the month. Data
for previous months is preserved.

<Note>

<EnterpriseAlert product="vault" inline />

License utilization cannot be reported if client counting is disabled.

As of 1.16.0, 1.15.6 and 1.14.10, client counting cannot be disabled as manual license utilization reporting is always enabled.

As of 1.14.0, 1.13.4, 1.12.8 and 1.11.12, client counting cannot be disabled when automated license utilization reporting is enabled.

</Note>


### Can I configure Vault to log the client count data? ((#log-client-count))

**Yes**.
Expand Down
Loading