Skip to content

New ecctl installation guide#769

Open
eedugon wants to merge 11 commits into
masterfrom
install_instructions
Open

New ecctl installation guide#769
eedugon wants to merge 11 commits into
masterfrom
install_instructions

Conversation

@eedugon

@eedugon eedugon commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the ecctl installation guide to cover multiple operating systems instead of only macOS.

Adds Linux (deb/rpm and binary), Windows (go install), and source-build installation paths, plus verification, upgrade, and basic troubleshooting sections.

This PR also promotes the info from the public KB article https://support.elastic.co/knowledge/f454ec94 (internal link) and the internal article https://support.elastic.dev/knowledge/view/1a0ccf8a into docs.

Related Issues

Closes #582

Motivation and Context

Existing installation guide only covers MacOS, and we create also binaries and RPM/DEB packages for Linux .

How Has This Been Tested?

Untested (planning to test)

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improves code quality but has no user-facing effect)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation

Readiness Checklist

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

@eedugon eedugon requested review from a team and alaudazzi as code owners June 23, 2026 08:31
@eedugon eedugon added the documentation Improvements or additions to documentation label Jun 23, 2026
@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown

🔍 Preview links for changed docs

@mlliarm mlliarm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

@eedugon eedugon requested review from yetanothertw and removed request for alaudazzi June 26, 2026 09:17
@eedugon

eedugon commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Tests completed, all worked well:

  • Linux .deb install
  • Binary from GitHub release (Linux)
  • Building from source (Linux)

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm. agree with doing a pretty lightweight fix of this page and not spending too much time on polish. couple of small comments to consider to make this page a tiny bit more usable (being able to copy a command with the latest version is a nice ergonomic boost)

Comment thread docs/reference/ecctl-installing.md Outdated
Comment thread docs/reference/ecctl-installing.md Outdated
Comment thread docs/reference/ecctl-installing.md Outdated
Comment thread docs/reference/ecctl-installing.md Outdated
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
@eedugon

eedugon commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

@gigerdo , sorry for the noise here, but I've applied some extra changes to the doc, including the optional checksum verification of the downloaded files. Just in case you want to apply a quick review again here.

Comment thread docs/reference/ecctl-installing.md Outdated
Comment thread docs/reference/ecctl-installing.md Outdated
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] ECCTL: Installing section only containing macOS

4 participants