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

renaming "elastic" user to "username" in cloud setup docs #40720

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

rehanpfmr
Copy link

This pull request primarily involves changes to the authentication credentials in various configuration files and documentation. The key change is the replacement of the default username "elastic" with "username". This is reflected in the CHANGELOG-developer.asciidoc and CHANGELOG-developer.next.asciidoc files, which list this as a breaking change.

Authentication Credentials Update:

auditbeat/auditbeat.reference.yml, auditbeat/auditbeat.yml, deploy/cloudfoundry/filebeat/filebeat.yml, deploy/cloudfoundry/metricbeat/metricbeat.yml, dev-tools/packaging/files/ironbank/auditbeat/config/auditbeat.yml, filebeat/filebeat.reference.yml, filebeat/filebeat.yml: Updated the commented-out default username from "elastic" to "username" in the authentication credentials section. [1] [2] [3] [4] [5] [6] [7] [8] [9]
Documentation Update:

CHANGELOG-developer.asciidoc, CHANGELOG-developer.next.asciidoc: Documented the change in default username as a breaking change. [1] [2]
libbeat/docs/monitoring/monitoring-internal-collection.asciidoc, libbeat/docs/output-cloud.asciidoc, x-pack/functionbeat/docs/config-options-aws.asciidoc: Updated the example configuration to reflect the new default username. [1] [2] [3]

@rehanpfmr rehanpfmr requested review from a team as code owners September 10, 2024 08:02
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Sep 10, 2024
Copy link

cla-checker-service bot commented Sep 10, 2024

❌ Author of the following commits did not sign a Contributor Agreement:
1fa80ff, da2f58b, bfb1a5b, 5d0fd52, d83dcd8

Please, read and sign the above mentioned agreement if you want to contribute to this project

Copy link
Contributor

mergify bot commented Sep 10, 2024

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @rehanpfmr? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-v8.x has been added to help with the transition to the new branch 8.x.

@belimawr
Copy link
Contributor

Hi @rehanpfmr, I'm trying to understand the motivation for this change, "elastic" is the default username we use in our documentation, it is also the default username used by Elasticsearch, many of our testing/automation tools as well as the username used when deploying on Elastic Cloud and using the cloud ID. I fail to see the benefit of this change.

@rehanpfmr
Copy link
Author

@belimawr , this is in context to #29862
There was an ask for updating the elastic to username, for which i requested an PR

Copy link
Contributor

mergify bot commented Sep 11, 2024

backport-8.x has been added to help with the transition to the new branch 8.x.

@mergify mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Sep 11, 2024
@v1v v1v removed the backport-v8.x label Sep 11, 2024
Copy link
Contributor

@belimawr belimawr left a comment

Choose a reason for hiding this comment

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

Another thing I didn't understand is why you removed auditbeat/module/file_integrity/testdata/garble_macho_executable.

CHANGELOG-developer.asciidoc Outdated Show resolved Hide resolved
CHANGELOG-developer.next.asciidoc Outdated Show resolved Hide resolved
#username: "elastic"
#username: "username"
Copy link
Contributor

Choose a reason for hiding this comment

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

Our documentation files are auto-generated based on templates, I don't see the templates modified on this PR, there are two of them:

  • libbeat/_meta/config/output-elasticsearch.yml.tmpl
  • libbeat/_meta/config/output-elasticsearch.reference.yml.tmpl

After editing them, you can generate all files by running make update from the root of the repo.

Copy link
Author

Choose a reason for hiding this comment

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

@belimawr , that helps. i will work on the above recommendation's and update PR accoringly

@belimawr
Copy link
Contributor

@belimawr , this is in context to #29862 There was an ask for updating the elastic to username, for which i requested an PR

Thanks for the context! I wasn't aware of this request.

A tip for next time: put those references in the PR description.

@pierrehilbert pierrehilbert added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Sep 16, 2024
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Sep 16, 2024
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

rehanpfmr and others added 5 commits October 1, 2024 12:04
	modified:   libbeat/docs/monitoring/monitoring-internal-collection.asciidoc
	modified:   libbeat/docs/output-cloud.asciidoc
	modified:   x-pack/functionbeat/docs/config-options-aws.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants