Skip to content

[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var#89003

Merged
lockewritesdocs merged 1 commit intoelastic:mainfrom
ebuildy:patch-1
Aug 4, 2022
Merged

[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var#89003
lockewritesdocs merged 1 commit intoelastic:mainfrom
ebuildy:patch-1

Conversation

@ebuildy
Copy link
Copy Markdown
Contributor

@ebuildy ebuildy commented Aug 1, 2022 •
edited
Loading

The commit 1d4534f changes the env variable ES_JAVA_OPTS to CLI_JAVA_OPTS. Doc must be updated as well.

Relate to #85821

  • Have you signed the contributor license agreement?
  • Have you followed the contributor guidelines?
  • If submitting code, have you built your formula locally prior to submission with gradle check?
  • If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
  • If submitting code, have you checked that your submission is for an OS and architecture that we support?
  • If you are submitting this code for a class then read our policy for that.

@ebuildy
Fix plugins CLI doc CLI_JAVA_OPTS env var
a5fa8e9 
The commit 1d4534f changes the env variable ``ES_JAVA_OPTS`` to ``CLI_JAVA_OPTS``. Doc must be updated as well.
@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v8.5.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Aug 1, 2022
@michaelbaamonde
Copy link
Copy Markdown
Contributor

michaelbaamonde commented Aug 1, 2022

I believe this would be in Core/Infra's purview, so labeling as such.

@michaelbaamonde michaelbaamonde added the Team:Core/Infra Meta label for core/infra team label Aug 1, 2022
@elasticsearchmachine elasticsearchmachine removed the Team:Core/Infra Meta label for core/infra team label Aug 1, 2022
@astefan astefan added the >docs General docs changes label Aug 2, 2022
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Aug 2, 2022
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

elasticsearchmachine commented Aug 2, 2022

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Aug 2, 2022
@astefan astefan added the :Core/Infra/Plugins Plugin API and infrastructure label Aug 2, 2022
@elasticsearchmachine elasticsearchmachine added the Team:Core/Infra Meta label for core/infra team label Aug 2, 2022
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

elasticsearchmachine commented Aug 2, 2022

Pinging @elastic/es-core-infra (Team:Core/Infra)

@lockewritesdocs
Copy link
Copy Markdown
Contributor

lockewritesdocs commented Aug 2, 2022

@rjernst, based on the changes in #85821, should we change ES_JAVA_OPTS to CLI_JAVA_OPTS throughout the documentation? We use this environment variable in ~8 different files.

@lockewritesdocs lockewritesdocs self-assigned this Aug 2, 2022
@williamrandolph
Copy link
Copy Markdown
Contributor

williamrandolph commented Aug 2, 2022

Ryan is on leave, but, yes, ES_JAVA_OPTS should be changed to CLI_JAVA_OPTS in documentation. The rationale for the change is that these options are not just used for Elasticsearch, but for other tools like the keystore tool or the plugin CLI. It looks like the remaining uses of ES_JAVA_OPTS outside of documentation need to be cleaned up as well.

@ebuildy
Copy link
Copy Markdown
Contributor Author

ebuildy commented Aug 3, 2022

I discovered this change because we build a Docker image to add elasticsearch plugins, using HTTP proxies. And our CI was broken from this commit #85821.

@lockewritesdocs lockewritesdocs self-requested a review August 4, 2022 13:03
lockewritesdocs
lockewritesdocs approved these changes Aug 4, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

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

Thanks for finding and fixing this issue @ebuildy! I'll update this variable in the remainder of our docs.

@lockewritesdocs lockewritesdocs changed the title Fix plugins CLI doc CLI_JAVA_OPTS env var [DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var Aug 4, 2022
@lockewritesdocs lockewritesdocs merged commit 2f0d9c8 into elastic:main Aug 4, 2022
@lockewritesdocs lockewritesdocs mentioned this pull request Aug 4, 2022
Merged
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Aug 4, 2022
@ebuildy
[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var (elastic#89003)
51f7daf 
The commit elastic@1d4534f changes the env variable ``ES_JAVA_OPTS`` to ``CLI_JAVA_OPTS``. Doc must be updated as well.
@lockewritesdocs lockewritesdocs mentioned this pull request Aug 4, 2022
Merged
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Aug 4, 2022
@ebuildy
[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var (elastic#89003)
ccdce5e 
The commit elastic@1d4534f changes the env variable ``ES_JAVA_OPTS`` to ``CLI_JAVA_OPTS``. Doc must be updated as well.
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

elasticsearchmachine commented Aug 4, 2022

💚 Backport successful

Status Branch Result
✅ 8.3
✅ 8.4

@lockewritesdocs lockewritesdocs mentioned this pull request Aug 4, 2022
Merged
elasticsearchmachine pushed a commit that referenced this pull request Aug 4, 2022
@ebuildy
[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var (#89003) (#89118)
f669500 
The commit 1d4534f changes the env variable ``ES_JAVA_OPTS`` to ``CLI_JAVA_OPTS``. Doc must be updated as well.

Co-authored-by: Thomas Decaux <ebuildy@gmail.com>
elasticsearchmachine pushed a commit that referenced this pull request Aug 4, 2022
@ebuildy
[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var (#89003) (#89119)
f866662 
The commit 1d4534f changes the env variable ``ES_JAVA_OPTS`` to ``CLI_JAVA_OPTS``. Doc must be updated as well.

Co-authored-by: Thomas Decaux <ebuildy@gmail.com>
@mark-vieira mark-vieira added v8.4.0 and removed v8.4.1 labels Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@lockewritesdocs lockewritesdocs lockewritesdocs approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@lockewritesdocs lockewritesdocs

Labels

:Core/Infra/Plugins Plugin API and infrastructure >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team v8.3.3 v8.4.0 v8.5.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@ebuildy @michaelbaamonde @elasticsearchmachine @lockewritesdocs @williamrandolph @astefan @mark-vieira