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

Deprecate apm-server apikey #9444

Closed
axw opened this issue Oct 26, 2022 · 1 comment · Fixed by #9446
Closed

Deprecate apm-server apikey #9444

axw opened this issue Oct 26, 2022 · 1 comment · Fixed by #9446

Comments

@axw
Copy link
Member

axw commented Oct 26, 2022

In 7.6 we introduced the apm-server apikey command, enabling users to manage API Keys for APM Agent authentication. This has always been labelled in the documentation as technical preview (previously known as "experimental").

In 8.0 we introduced support for managing API Keys for APM agents in the APM UI. The APM Guide directs users to the APM app. There is also a guide for creating API Keys through the Elasticsearch REST API, for users who might need to automate API Key management.

The future of API Key management is through Kibana and Elasticsearch. We should deprecate and remove apm-server apikey. Technically we could immediately remove the command since it never made it out of technical preview. However, the command has been available for almost 3 years, so I think that would be too rash. We shouldn't wait too long either, since the UI has been available since 8.0. Let's deprecate it and give 1-2 minor releases notice before removing.

I propose we add a deprecation notice to the documentation and command description, and log a warning when the command is invoked.

@axw axw added this to the 8.6 milestone Oct 26, 2022
@axw axw mentioned this issue Oct 27, 2022
2 tasks
@axw axw self-assigned this Oct 27, 2022
@axw axw added the v8.6.0 label Oct 28, 2022
@axw axw closed this as completed in #9446 Oct 28, 2022
@axw axw removed their assignment Nov 15, 2022
@lahsivjar
Copy link
Contributor

Tested on branch 8.6:

$ ./apm-server -h | grep deprecated 
apikey      Manage API Keys for communication between APM agents and server (deprecated)
$ ./apm-server apikey -h | grep deprecated
Manage API Keys for communication between APM agents and server (deprecated).
NOTE: "apm-server apikey" is deprecated, and will be removed in a future release.
$ ./apm-server apikey create | grep deprecated
...

NOTE: "apm-server apikey" is deprecated, and will be removed in a future release.
See https://www.elastic.co/guide/en/apm/guide/current/api-key.html for managing API Keys.

@lahsivjar lahsivjar self-assigned this Nov 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants