* upgrade hcl dependency on api pkg
This upgrades the hcl dependency for the API pkg,
and adapts its usage so users of our API pkg are
not affected. There's no good way of communicating
a warning via a library call so we don't.
The tokenHelper which is used by all Vault CLI
commands in order to create the Vault client, as
well as directly used by the login and server
commands, is implemented on the api pkg, so this
upgrade also affects all of those commands. Seems
like this was only moved to the api pkg because
the Terraform provider uses it, and I thought
creating a full copy of all those files back under
command would be too much spaghetti.
Also leaving some TODOs to make next deprecation
steps easier.
* upgrade hcl dependency in vault and sdk pkgs
* upgrade hcl dependency in vault and sdk pkgs
* add CLI warnings to commands that take a config
- vault agent (unit test on CMD warning)
- vault proxy (unit test on CMD warning)
- vault server (no test for the warning)
- vault operator diagnose (no tests at all, uses the
same function as vault server
* ignore duplicates on ParseKMSes function
* Extend policy parsing functions and warn on policy store
* Add warning on policy fmt with duplicate attributes
* Add warnings when creating/updating policy with duplicate HCL attrs
* Add log warning when switchedGetPolicy finds duplicate attrs
Following operations can trigger this warning when they run into a policy
with duplicate attributes:
* replication filtered path namespaces invalidation
* policy read API
* building an ACL (for many different purposes like most authZ operations)
* looking up DR token policies
* creating a token with named policies
* when caching the policies for all namespaces during unseal
* Print log warnings when token inline policy has duplicate attrs
No unit tests on these as new test infra would have to be built on all.
Operations affected, which will now print a log warning when the retrieved
token has an inline policy with duplicate attributes:
* capabilities endpoints in sys mount
* handing events under a subscription with a token with duplicate
attrs in inline policies
* token used to create another token has duplicate attrs in inline
policies (sudo check)
* all uses of fetchACLTokenEntryAndEntity when the request uses a
token with inline policies with duplicate attrs. Almost all reqs
are subject to this
* when tokens are created with inline policies (unclear exactly how that
can happen)
* add changelog and deprecation notice
* add missing copywrite notice
* fix copy-paste mistake
good thing it was covered by unit tests
* Fix manual parsing of telemetry field in SharedConfig
This commit in the hcl library was not in the
v1.0.1-vault-5 version we're using but is
included in v1.0.1-vault-7:
|
||
---|---|---|
.. | ||
database | ||
framework | ||
helper | ||
logical | ||
physical | ||
plugin | ||
queue | ||
rotation | ||
.copywrite.hcl | ||
go.mod | ||
go.sum | ||
LICENSE | ||
README.md |
Vault SDK libs
This package provides the sdk
package which contains code useful for
developing Vault plugins.
Although we try not to break functionality, we reserve the right to reorganize
the code at will and may occasionally cause breaks if they are warranted. As
such we expect the tag of this module will stay less than v1.0.0
.
For any major changes we will try to give advance notice in the CHANGES section of Vault's CHANGELOG.md.
Metrics Emission and Compatibility
This module can emit metrics using either github.com/armon/go-metrics
or github.com/hashicorp/go-metrics
. Choosing between the libraries is controlled via build tags.
Build Tags
armonmetrics
- Using this tag will cause metrics to be routed toarmon/go-metrics
hashicorpmetrics
- Using this tag will cause all metrics to be routed tohashicorp/go-metrics
If no build tag is specified, the default behavior is to use armon/go-metrics
.
Deprecating armon/go-metrics
Emitting metrics to armon/go-metrics
is officially deprecated. Usage of armon/go-metrics
will remain the default until mid-2025 with opt-in support continuing to the end of 2025.
Migration
To migrate an application currently using the older armon/go-metrics
to instead use hashicorp/go-metrics
the following should be done.
- Upgrade libraries using
armon/go-metrics
to consumehashicorp/go-metrics/compat
instead. This should involve only changing import statements. All repositories in thehashicorp
namespace will be migrated by February of 2025. - Update the application's library dependencies to those that have the compatibility layer configured.
- Update the application to use
hashicorp/go-metrics
for configuring metrics export instead ofarmon/go-metrics
- Replace all application imports of
github.com/armon/go-metrics
withgithub.com/hashicorp/go-metrics
- Instrument your build system to build with the
hashicorpmetrics
tag.
- Replace all application imports of