elastic / elastic-package

elastic-package - Command line tool for developing Elastic Integrations
Other
49 stars 112 forks source link

[docs] Clarify custom Docker/YAML settings #2046

Closed nicpenning closed 3 weeks ago

nicpenning commented 3 weeks ago

Today there is the concept of profiles. They are a bit confusing and the documentation isn't very clear to me.

I created a new profile using elastic-package profiles create test-prof and then elastic-package profiles set test-prof and that appears to work from what I see in the output when I start the stack.

However, the confusion is that when I modify either the docker-compose.yml or the kibana.yml (before I start the stack), it appears they are getting overwritten (after the stack up command is used) to the default settings and my custom settings are not used.

Is there something else we need to modify so we can control the docker-compose.yml and/or kibana.yml?

jsoriano commented 3 weeks ago

However, the confusion is that when I modify either the docker-compose.yml or the kibana.yml (before I start the stack), it appears they are getting overwritten (after the stack up command is used) to the default settings and my custom settings are not used.

Correct, these files are not expected to be modified. They should be considered internal and can be always overwritten by stack up.

Is there something else we need to modify so we can control the docker-compose.yml and/or kibana.yml?

The only part of the profile that is intended to be modified by users is the config.yml file, that can contain certain parameters. These parameters are persisted. They can also be modified when running stack up with the -U/--parameter flag.

You can find more info about this and the available parameters in https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-profiles-1

If you need to customize something that is not available as parameter yet, please create an issue for that.

nicpenning commented 3 weeks ago

Sounds good, thank you.