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

Added args -v and -esonly + test refactor #41

Merged
merged 4 commits into from
Feb 21, 2025
Merged

Added args -v and -esonly + test refactor #41

merged 4 commits into from
Feb 21, 2025

Conversation

ezimuel
Copy link
Collaborator

@ezimuel ezimuel commented Feb 20, 2025

This PR adds the following options to start-local.sh script:

  • -v <version>, where <version> is the Elasticsearch (and Kibana) version to be installed.
  • -esonly, install only Elasticsearch, without Kibana.

By default, the start-local.sh script uses the latest stable version of Elastic stack. To use the -v option, you can use the following command:

curl -fsSL https://elastic.co/start-local | sh -s -- -v 9.0.0-beta1

For instance, the previous command installs the 9.0.0-beta1 version.

The other option, -esonly can be used to install only Elasticsearch, without Kibana:

curl -fsSL https://elastic.co/start-local | sh -s -- -esonly

You can also mix the parameters, for instance install only Elasticsearch with a specific version (e.g. 8.16.0), as follows:

curl -fsSL https://elastic.co/start-local | sh -s -- -v 8.16.0 -esonly

This PR includes also a refactor of the tests, adding two specific tests for the -v and -esonly options.

@ezimuel ezimuel requested a review from xeraa February 20, 2025 22:02
Copy link

@xeraa xeraa left a comment

Choose a reason for hiding this comment

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

Only left 2 minor comments

README.md Outdated
@@ -40,6 +40,38 @@ This script creates an `elastic-start-local` folder containing:
- `start.sh` and `stop.sh`: Scripts to start and stop Elasticsearch and Kibana
- `uninstall.sh`: The script to uninstall Elasticsearch and Kibana

### Select the version to install

By default, `stat-local` uses the latest stable version of Elastic stack. If you want, you can specify
Copy link

Choose a reason for hiding this comment

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

start-local misses an R. Also Stack with a capital S would IMO be preferred.

as follows:

```bash
curl -fsSL https://elastic.co/start-local | sh -s -- -esonly
Copy link

@xeraa xeraa Feb 20, 2025

Choose a reason for hiding this comment

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

More of a random thought: Should we introduce the concept of a "profile"? Like esonly but there could also be security, otel, observability,... Maybe going too far — we can keep it as a thought for a future refactoring.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, that's the idea for future options, like o11y, security, genai, etc. These options will change the docker-compose configuration and enabling by default some settings, like the ELSER for genai, etc. We'll discuss more about this in the next days.

@ezimuel
Copy link
Collaborator Author

ezimuel commented Feb 21, 2025

Thanks @xeraa for the review!

@ezimuel ezimuel merged commit 755a917 into main Feb 21, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants